Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/arm-logic

Index

Classes

Interfaces

Type aliases

Variables

Object literals

Type aliases

AgreementType

AgreementType: "NotSpecified" | "AS2" | "X12" | "Edifact"

Defines values for AgreementType. Possible values include: 'NotSpecified', 'AS2', 'X12', 'Edifact'

readonly
enum

{string}

DayOfWeek

DayOfWeek: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"

Defines values for DayOfWeek. Possible values include: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'

readonly
enum

{string}

DaysOfWeek

DaysOfWeek: "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday"

Defines values for DaysOfWeek. Possible values include: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'

readonly
enum

{string}

EdifactCharacterSet

EdifactCharacterSet: "NotSpecified" | "UNOB" | "UNOA" | "UNOC" | "UNOD" | "UNOE" | "UNOF" | "UNOG" | "UNOH" | "UNOI" | "UNOJ" | "UNOK" | "UNOX" | "UNOY" | "KECA"

Defines values for EdifactCharacterSet. Possible values include: 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA'

readonly
enum

{string}

EdifactDecimalIndicator

EdifactDecimalIndicator: "NotSpecified" | "Comma" | "Decimal"

Defines values for EdifactDecimalIndicator. Possible values include: 'NotSpecified', 'Comma', 'Decimal'

readonly
enum

{string}

EncryptionAlgorithm

EncryptionAlgorithm: "NotSpecified" | "None" | "DES3" | "RC2" | "AES128" | "AES192" | "AES256"

Defines values for EncryptionAlgorithm. Possible values include: 'NotSpecified', 'None', 'DES3', 'RC2', 'AES128', 'AES192', 'AES256'

readonly
enum

{string}

EventLevel

EventLevel: "LogAlways" | "Critical" | "Error" | "Warning" | "Informational" | "Verbose"

Defines values for EventLevel. Possible values include: 'LogAlways', 'Critical', 'Error', 'Warning', 'Informational', 'Verbose'

readonly
enum

{string}

HashingAlgorithm

HashingAlgorithm: "NotSpecified" | "None" | "MD5" | "SHA1" | "SHA2256" | "SHA2384" | "SHA2512"

Defines values for HashingAlgorithm. Possible values include: 'NotSpecified', 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512'

readonly
enum

{string}

IntegrationAccountAgreementsCreateOrUpdateResponse

IntegrationAccountAgreementsCreateOrUpdateResponse: IntegrationAccountAgreement & object

Contains response data for the createOrUpdate operation.

IntegrationAccountAgreementsGetResponse

IntegrationAccountAgreementsGetResponse: IntegrationAccountAgreement & object

Contains response data for the get operation.

IntegrationAccountAgreementsListContentCallbackUrlResponse

IntegrationAccountAgreementsListContentCallbackUrlResponse: WorkflowTriggerCallbackUrl & object

Contains response data for the listContentCallbackUrl operation.

IntegrationAccountAgreementsListNextResponse

IntegrationAccountAgreementsListNextResponse: IntegrationAccountAgreementListResult & object

Contains response data for the listNext operation.

IntegrationAccountAgreementsListResponse

IntegrationAccountAgreementsListResponse: IntegrationAccountAgreementListResult & object

Contains response data for the list operation.

IntegrationAccountAssembliesCreateOrUpdateResponse

IntegrationAccountAssembliesCreateOrUpdateResponse: AssemblyDefinition & object

Contains response data for the createOrUpdate operation.

IntegrationAccountAssembliesGetResponse

IntegrationAccountAssembliesGetResponse: AssemblyDefinition & object

Contains response data for the get operation.

IntegrationAccountAssembliesListContentCallbackUrlResponse

IntegrationAccountAssembliesListContentCallbackUrlResponse: WorkflowTriggerCallbackUrl & object

Contains response data for the listContentCallbackUrl operation.

IntegrationAccountAssembliesListResponse

IntegrationAccountAssembliesListResponse: AssemblyCollection & object

Contains response data for the list operation.

IntegrationAccountBatchConfigurationsCreateOrUpdateResponse

IntegrationAccountBatchConfigurationsCreateOrUpdateResponse: BatchConfiguration & object

Contains response data for the createOrUpdate operation.

IntegrationAccountBatchConfigurationsGetResponse

IntegrationAccountBatchConfigurationsGetResponse: BatchConfiguration & object

Contains response data for the get operation.

IntegrationAccountBatchConfigurationsListResponse

IntegrationAccountBatchConfigurationsListResponse: BatchConfigurationCollection & object

Contains response data for the list operation.

IntegrationAccountCertificatesCreateOrUpdateResponse

IntegrationAccountCertificatesCreateOrUpdateResponse: IntegrationAccountCertificate & object

Contains response data for the createOrUpdate operation.

IntegrationAccountCertificatesGetResponse

IntegrationAccountCertificatesGetResponse: IntegrationAccountCertificate & object

Contains response data for the get operation.

IntegrationAccountCertificatesListNextResponse

IntegrationAccountCertificatesListNextResponse: IntegrationAccountCertificateListResult & object

Contains response data for the listNext operation.

IntegrationAccountCertificatesListResponse

IntegrationAccountCertificatesListResponse: IntegrationAccountCertificateListResult & object

Contains response data for the list operation.

IntegrationAccountMapsCreateOrUpdateResponse

IntegrationAccountMapsCreateOrUpdateResponse: IntegrationAccountMap & object

Contains response data for the createOrUpdate operation.

IntegrationAccountMapsGetResponse

IntegrationAccountMapsGetResponse: IntegrationAccountMap & object

Contains response data for the get operation.

IntegrationAccountMapsListContentCallbackUrlResponse

IntegrationAccountMapsListContentCallbackUrlResponse: WorkflowTriggerCallbackUrl & object

Contains response data for the listContentCallbackUrl operation.

IntegrationAccountMapsListNextResponse

IntegrationAccountMapsListNextResponse: IntegrationAccountMapListResult & object

Contains response data for the listNext operation.

IntegrationAccountMapsListResponse

IntegrationAccountMapsListResponse: IntegrationAccountMapListResult & object

Contains response data for the list operation.

IntegrationAccountPartnersCreateOrUpdateResponse

IntegrationAccountPartnersCreateOrUpdateResponse: IntegrationAccountPartner & object

Contains response data for the createOrUpdate operation.

IntegrationAccountPartnersGetResponse

IntegrationAccountPartnersGetResponse: IntegrationAccountPartner & object

Contains response data for the get operation.

IntegrationAccountPartnersListContentCallbackUrlResponse

IntegrationAccountPartnersListContentCallbackUrlResponse: WorkflowTriggerCallbackUrl & object

Contains response data for the listContentCallbackUrl operation.

IntegrationAccountPartnersListNextResponse

IntegrationAccountPartnersListNextResponse: IntegrationAccountPartnerListResult & object

Contains response data for the listNext operation.

IntegrationAccountPartnersListResponse

IntegrationAccountPartnersListResponse: IntegrationAccountPartnerListResult & object

Contains response data for the list operation.

IntegrationAccountSchemasCreateOrUpdateResponse

IntegrationAccountSchemasCreateOrUpdateResponse: IntegrationAccountSchema & object

Contains response data for the createOrUpdate operation.

IntegrationAccountSchemasGetResponse

IntegrationAccountSchemasGetResponse: IntegrationAccountSchema & object

Contains response data for the get operation.

IntegrationAccountSchemasListContentCallbackUrlResponse

IntegrationAccountSchemasListContentCallbackUrlResponse: WorkflowTriggerCallbackUrl & object

Contains response data for the listContentCallbackUrl operation.

IntegrationAccountSchemasListNextResponse

IntegrationAccountSchemasListNextResponse: IntegrationAccountSchemaListResult & object

Contains response data for the listNext operation.

IntegrationAccountSchemasListResponse

IntegrationAccountSchemasListResponse: IntegrationAccountSchemaListResult & object

Contains response data for the list operation.

IntegrationAccountSessionsCreateOrUpdateResponse

IntegrationAccountSessionsCreateOrUpdateResponse: IntegrationAccountSession & object

Contains response data for the createOrUpdate operation.

IntegrationAccountSessionsGetResponse

IntegrationAccountSessionsGetResponse: IntegrationAccountSession & object

Contains response data for the get operation.

IntegrationAccountSessionsListNextResponse

IntegrationAccountSessionsListNextResponse: IntegrationAccountSessionListResult & object

Contains response data for the listNext operation.

IntegrationAccountSessionsListResponse

IntegrationAccountSessionsListResponse: IntegrationAccountSessionListResult & object

Contains response data for the list operation.

IntegrationAccountSkuName

IntegrationAccountSkuName: "NotSpecified" | "Free" | "Basic" | "Standard"

Defines values for IntegrationAccountSkuName. Possible values include: 'NotSpecified', 'Free', 'Basic', 'Standard'

readonly
enum

{string}

IntegrationAccountsCreateOrUpdateResponse

IntegrationAccountsCreateOrUpdateResponse: IntegrationAccount & object

Contains response data for the createOrUpdate operation.

IntegrationAccountsGetResponse

IntegrationAccountsGetResponse: IntegrationAccount & object

Contains response data for the get operation.

IntegrationAccountsListByResourceGroupNextResponse

IntegrationAccountsListByResourceGroupNextResponse: IntegrationAccountListResult & object

Contains response data for the listByResourceGroupNext operation.

IntegrationAccountsListByResourceGroupResponse

IntegrationAccountsListByResourceGroupResponse: IntegrationAccountListResult & object

Contains response data for the listByResourceGroup operation.

IntegrationAccountsListBySubscriptionNextResponse

IntegrationAccountsListBySubscriptionNextResponse: IntegrationAccountListResult & object

Contains response data for the listBySubscriptionNext operation.

IntegrationAccountsListBySubscriptionResponse

IntegrationAccountsListBySubscriptionResponse: IntegrationAccountListResult & object

Contains response data for the listBySubscription operation.

IntegrationAccountsListCallbackUrlResponse

IntegrationAccountsListCallbackUrlResponse: CallbackUrl & object

Contains response data for the listCallbackUrl operation.

IntegrationAccountsListKeyVaultKeysResponse

IntegrationAccountsListKeyVaultKeysResponse: KeyVaultKeyCollection & object

Contains response data for the listKeyVaultKeys operation.

IntegrationAccountsRegenerateAccessKeyResponse

IntegrationAccountsRegenerateAccessKeyResponse: IntegrationAccount & object

Contains response data for the regenerateAccessKey operation.

IntegrationAccountsUpdateResponse

IntegrationAccountsUpdateResponse: IntegrationAccount & object

Contains response data for the update operation.

KeyType

KeyType: "NotSpecified" | "Primary" | "Secondary"

Defines values for KeyType. Possible values include: 'NotSpecified', 'Primary', 'Secondary'

readonly
enum

{string}

MapType

MapType: "NotSpecified" | "Xslt" | "Xslt20" | "Xslt30" | "Liquid"

Defines values for MapType. Possible values include: 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', 'Liquid'

readonly
enum

{string}

MessageFilterType

MessageFilterType: "NotSpecified" | "Include" | "Exclude"

Defines values for MessageFilterType. Possible values include: 'NotSpecified', 'Include', 'Exclude'

readonly
enum

{string}

OperationsListNextResponse

OperationsListNextResponse: OperationListResult & object

Contains response data for the listNext operation.

OperationsListResponse

OperationsListResponse: OperationListResult & object

Contains response data for the list operation.

ParameterType

ParameterType: "NotSpecified" | "String" | "SecureString" | "Int" | "Float" | "Bool" | "Array" | "Object" | "SecureObject"

Defines values for ParameterType. Possible values include: 'NotSpecified', 'String', 'SecureString', 'Int', 'Float', 'Bool', 'Array', 'Object', 'SecureObject'

readonly
enum

{string}

PartnerType

PartnerType: "NotSpecified" | "B2B"

Defines values for PartnerType. Possible values include: 'NotSpecified', 'B2B'

readonly
enum

{string}

RecurrenceFrequency

RecurrenceFrequency: "NotSpecified" | "Second" | "Minute" | "Hour" | "Day" | "Week" | "Month" | "Year"

Defines values for RecurrenceFrequency. Possible values include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year'

readonly
enum

{string}

SchemaType

SchemaType: "NotSpecified" | "Xml"

Defines values for SchemaType. Possible values include: 'NotSpecified', 'Xml'

readonly
enum

{string}

SegmentTerminatorSuffix

SegmentTerminatorSuffix: "NotSpecified" | "None" | "CR" | "LF" | "CRLF"

Defines values for SegmentTerminatorSuffix. Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF'

readonly
enum

{string}

SigningAlgorithm

SigningAlgorithm: "NotSpecified" | "Default" | "SHA1" | "SHA2256" | "SHA2384" | "SHA2512"

Defines values for SigningAlgorithm. Possible values include: 'NotSpecified', 'Default', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512'

readonly
enum

{string}

SkuName

SkuName: "NotSpecified" | "Free" | "Shared" | "Basic" | "Standard" | "Premium"

Defines values for SkuName. Possible values include: 'NotSpecified', 'Free', 'Shared', 'Basic', 'Standard', 'Premium'

readonly
enum

{string}

TrackEventsOperationOptions

TrackEventsOperationOptions: "None" | "DisableSourceInfoEnrich"

Defines values for TrackEventsOperationOptions. Possible values include: 'None', 'DisableSourceInfoEnrich'

readonly
enum

{string}

TrackingRecordType

TrackingRecordType: "NotSpecified" | "Custom" | "AS2Message" | "AS2MDN" | "X12Interchange" | "X12FunctionalGroup" | "X12TransactionSet" | "X12InterchangeAcknowledgment" | "X12FunctionalGroupAcknowledgment" | "X12TransactionSetAcknowledgment" | "EdifactInterchange" | "EdifactFunctionalGroup" | "EdifactTransactionSet" | "EdifactInterchangeAcknowledgment" | "EdifactFunctionalGroupAcknowledgment" | "EdifactTransactionSetAcknowledgment"

Defines values for TrackingRecordType. Possible values include: 'NotSpecified', 'Custom', 'AS2Message', 'AS2MDN', 'X12Interchange', 'X12FunctionalGroup', 'X12TransactionSet', 'X12InterchangeAcknowledgment', 'X12FunctionalGroupAcknowledgment', 'X12TransactionSetAcknowledgment', 'EdifactInterchange', 'EdifactFunctionalGroup', 'EdifactTransactionSet', 'EdifactInterchangeAcknowledgment', 'EdifactFunctionalGroupAcknowledgment', 'EdifactTransactionSetAcknowledgment'

readonly
enum

{string}

TrailingSeparatorPolicy

TrailingSeparatorPolicy: "NotSpecified" | "NotAllowed" | "Optional" | "Mandatory"

Defines values for TrailingSeparatorPolicy. Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', 'Mandatory'

readonly
enum

{string}

UsageIndicator

UsageIndicator: "NotSpecified" | "Test" | "Information" | "Production"

Defines values for UsageIndicator. Possible values include: 'NotSpecified', 'Test', 'Information', 'Production'

readonly
enum

{string}

WorkflowProvisioningState

WorkflowProvisioningState: "NotSpecified" | "Accepted" | "Running" | "Ready" | "Creating" | "Created" | "Deleting" | "Deleted" | "Canceled" | "Failed" | "Succeeded" | "Moving" | "Updating" | "Registering" | "Registered" | "Unregistering" | "Unregistered" | "Completed"

Defines values for WorkflowProvisioningState. Possible values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', 'Succeeded', 'Moving', 'Updating', 'Registering', 'Registered', 'Unregistering', 'Unregistered', 'Completed'

readonly
enum

{string}

WorkflowRunActionRepetitionsGetResponse

WorkflowRunActionRepetitionsGetResponse: WorkflowRunActionRepetitionDefinition & object

Contains response data for the get operation.

WorkflowRunActionRepetitionsListExpressionTracesResponse

WorkflowRunActionRepetitionsListExpressionTracesResponse: ExpressionTraces & object

Contains response data for the listExpressionTraces operation.

WorkflowRunActionRepetitionsListResponse

WorkflowRunActionRepetitionsListResponse: WorkflowRunActionRepetitionDefinitionCollection & object

Contains response data for the list operation.

WorkflowRunActionRepetitionsRequestHistoriesGetResponse

WorkflowRunActionRepetitionsRequestHistoriesGetResponse: RequestHistory & object

Contains response data for the get operation.

WorkflowRunActionRepetitionsRequestHistoriesListNextResponse

WorkflowRunActionRepetitionsRequestHistoriesListNextResponse: RequestHistoryListResult & object

Contains response data for the listNext operation.

WorkflowRunActionRepetitionsRequestHistoriesListResponse

WorkflowRunActionRepetitionsRequestHistoriesListResponse: RequestHistoryListResult & object

Contains response data for the list operation.

WorkflowRunActionRequestHistoriesGetResponse

WorkflowRunActionRequestHistoriesGetResponse: RequestHistory & object

Contains response data for the get operation.

WorkflowRunActionRequestHistoriesListNextResponse

WorkflowRunActionRequestHistoriesListNextResponse: RequestHistoryListResult & object

Contains response data for the listNext operation.

WorkflowRunActionRequestHistoriesListResponse

WorkflowRunActionRequestHistoriesListResponse: RequestHistoryListResult & object

Contains response data for the list operation.

WorkflowRunActionScopeRepetitionsGetResponse

WorkflowRunActionScopeRepetitionsGetResponse: WorkflowRunActionRepetitionDefinition & object

Contains response data for the get operation.

WorkflowRunActionScopeRepetitionsListResponse

WorkflowRunActionScopeRepetitionsListResponse: WorkflowRunActionRepetitionDefinitionCollection & object

Contains response data for the list operation.

WorkflowRunActionsGetResponse

WorkflowRunActionsGetResponse: WorkflowRunAction & object

Contains response data for the get operation.

WorkflowRunActionsListExpressionTracesResponse

WorkflowRunActionsListExpressionTracesResponse: ExpressionTraces & object

Contains response data for the listExpressionTraces operation.

WorkflowRunActionsListNextResponse

WorkflowRunActionsListNextResponse: WorkflowRunActionListResult & object

Contains response data for the listNext operation.

WorkflowRunActionsListResponse

WorkflowRunActionsListResponse: WorkflowRunActionListResult & object

Contains response data for the list operation.

WorkflowRunOperationsGetResponse

WorkflowRunOperationsGetResponse: WorkflowRun & object

Contains response data for the get operation.

WorkflowRunsGetResponse

WorkflowRunsGetResponse: WorkflowRun & object

Contains response data for the get operation.

WorkflowRunsListNextResponse

WorkflowRunsListNextResponse: WorkflowRunListResult & object

Contains response data for the listNext operation.

WorkflowRunsListResponse

WorkflowRunsListResponse: WorkflowRunListResult & object

Contains response data for the list operation.

WorkflowState

WorkflowState: "NotSpecified" | "Completed" | "Enabled" | "Disabled" | "Deleted" | "Suspended"

Defines values for WorkflowState. Possible values include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended'

readonly
enum

{string}

WorkflowStatus

WorkflowStatus: "NotSpecified" | "Paused" | "Running" | "Waiting" | "Succeeded" | "Skipped" | "Suspended" | "Cancelled" | "Failed" | "Faulted" | "TimedOut" | "Aborted" | "Ignored"

Defines values for WorkflowStatus. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored'

readonly
enum

{string}

WorkflowTriggerHistoriesGetResponse

WorkflowTriggerHistoriesGetResponse: WorkflowTriggerHistory & object

Contains response data for the get operation.

WorkflowTriggerHistoriesListNextResponse

WorkflowTriggerHistoriesListNextResponse: WorkflowTriggerHistoryListResult & object

Contains response data for the listNext operation.

WorkflowTriggerHistoriesListResponse

WorkflowTriggerHistoriesListResponse: WorkflowTriggerHistoryListResult & object

Contains response data for the list operation.

WorkflowTriggerProvisioningState

WorkflowTriggerProvisioningState: "NotSpecified" | "Accepted" | "Running" | "Ready" | "Creating" | "Created" | "Deleting" | "Deleted" | "Canceled" | "Failed" | "Succeeded" | "Moving" | "Updating" | "Registering" | "Registered" | "Unregistering" | "Unregistered" | "Completed"

Defines values for WorkflowTriggerProvisioningState. Possible values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', 'Succeeded', 'Moving', 'Updating', 'Registering', 'Registered', 'Unregistering', 'Unregistered', 'Completed'

readonly
enum

{string}

WorkflowTriggersGetResponse

WorkflowTriggersGetResponse: WorkflowTrigger & object

Contains response data for the get operation.

WorkflowTriggersGetSchemaJsonResponse

WorkflowTriggersGetSchemaJsonResponse: JsonSchema & object

Contains response data for the getSchemaJson operation.

WorkflowTriggersListCallbackUrlResponse

WorkflowTriggersListCallbackUrlResponse: WorkflowTriggerCallbackUrl & object

Contains response data for the listCallbackUrl operation.

WorkflowTriggersListNextResponse

WorkflowTriggersListNextResponse: WorkflowTriggerListResult & object

Contains response data for the listNext operation.

WorkflowTriggersListResponse

WorkflowTriggersListResponse: WorkflowTriggerListResult & object

Contains response data for the list operation.

WorkflowTriggersRunResponse

WorkflowTriggersRunResponse: object

Contains response data for the run operation.

Type declaration

WorkflowVersionTriggersListCallbackUrlResponse

WorkflowVersionTriggersListCallbackUrlResponse: WorkflowTriggerCallbackUrl & object

Contains response data for the listCallbackUrl operation.

WorkflowVersionsGetResponse

WorkflowVersionsGetResponse: WorkflowVersion & object

Contains response data for the get operation.

WorkflowVersionsListNextResponse

WorkflowVersionsListNextResponse: WorkflowVersionListResult & object

Contains response data for the listNext operation.

WorkflowVersionsListResponse

WorkflowVersionsListResponse: WorkflowVersionListResult & object

Contains response data for the list operation.

WorkflowsCreateOrUpdateResponse

WorkflowsCreateOrUpdateResponse: Workflow & object

Contains response data for the createOrUpdate operation.

WorkflowsGenerateUpgradedDefinitionResponse

WorkflowsGenerateUpgradedDefinitionResponse: object

Contains response data for the generateUpgradedDefinition operation.

Type declaration

WorkflowsGetResponse

WorkflowsGetResponse: Workflow & object

Contains response data for the get operation.

WorkflowsListByResourceGroupNextResponse

WorkflowsListByResourceGroupNextResponse: WorkflowListResult & object

Contains response data for the listByResourceGroupNext operation.

WorkflowsListByResourceGroupResponse

WorkflowsListByResourceGroupResponse: WorkflowListResult & object

Contains response data for the listByResourceGroup operation.

WorkflowsListBySubscriptionNextResponse

WorkflowsListBySubscriptionNextResponse: WorkflowListResult & object

Contains response data for the listBySubscriptionNext operation.

WorkflowsListBySubscriptionResponse

WorkflowsListBySubscriptionResponse: WorkflowListResult & object

Contains response data for the listBySubscription operation.

WorkflowsListCallbackUrlResponse

WorkflowsListCallbackUrlResponse: WorkflowTriggerCallbackUrl & object

Contains response data for the listCallbackUrl operation.

WorkflowsListSwaggerResponse

WorkflowsListSwaggerResponse: object

Contains response data for the listSwagger operation.

Type declaration

WorkflowsUpdateResponse

WorkflowsUpdateResponse: Workflow & object

Contains response data for the update operation.

X12CharacterSet

X12CharacterSet: "NotSpecified" | "Basic" | "Extended" | "UTF8"

Defines values for X12CharacterSet. Possible values include: 'NotSpecified', 'Basic', 'Extended', 'UTF8'

readonly
enum

{string}

X12DateFormat

X12DateFormat: "NotSpecified" | "CCYYMMDD" | "YYMMDD"

Defines values for X12DateFormat. Possible values include: 'NotSpecified', 'CCYYMMDD', 'YYMMDD'

readonly
enum

{string}

X12TimeFormat

X12TimeFormat: "NotSpecified" | "HHMM" | "HHMMSS" | "HHMMSSdd" | "HHMMSSd"

Defines values for X12TimeFormat. Possible values include: 'NotSpecified', 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd'

readonly
enum

{string}

Variables

Const BaseResource

BaseResource: CompositeMapper = BaseResourceMapper

Const CloudError

CloudError: CompositeMapper = CloudErrorMapper

Object literals

Const AS2AcknowledgementConnectionSettings

AS2AcknowledgementConnectionSettings: object

The AS2 agreement acknowledgement connection settings.

ignoreCertificateNameMismatch

ignoreCertificateNameMismatch: boolean

The value indicating whether to ignore mismatch in certificate name.

keepHttpConnectionAlive

keepHttpConnectionAlive: boolean

The value indicating whether to keep the connection alive.

supportHttpStatusCodeContinue

supportHttpStatusCodeContinue: boolean

The value indicating whether to support HTTP status code 'CONTINUE'.

unfoldHttpHeaders

unfoldHttpHeaders: boolean

The value indicating whether to unfold the HTTP headers.

serializedName

serializedName: string = "AS2AcknowledgementConnectionSettings"

type

type: object

className

className: string = "AS2AcknowledgementConnectionSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ignoreCertificateNameMismatch

ignoreCertificateNameMismatch: object

required

required: true = true

serializedName

serializedName: string = "ignoreCertificateNameMismatch"

type

type: object

name

name: "Boolean" = "Boolean"

keepHttpConnectionAlive

keepHttpConnectionAlive: object

required

required: true = true

serializedName

serializedName: string = "keepHttpConnectionAlive"

type

type: object

name

name: "Boolean" = "Boolean"

supportHttpStatusCodeContinue

supportHttpStatusCodeContinue: object

required

required: true = true

serializedName

serializedName: string = "supportHttpStatusCodeContinue"

type

type: object

name

name: "Boolean" = "Boolean"

unfoldHttpHeaders

unfoldHttpHeaders: object

required

required: true = true

serializedName

serializedName: string = "unfoldHttpHeaders"

type

type: object

name

name: "Boolean" = "Boolean"

Const AS2AgreementContent

AS2AgreementContent: object

The integration account AS2 agreement content.

receiveAgreement

receiveAgreement: AS2OneWayAgreement

The AS2 one-way receive agreement.

sendAgreement

sendAgreement: AS2OneWayAgreement

The AS2 one-way send agreement.

serializedName

serializedName: string = "AS2AgreementContent"

type

type: object

className

className: string = "AS2AgreementContent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

receiveAgreement

receiveAgreement: object

required

required: true = true

serializedName

serializedName: string = "receiveAgreement"

type

type: object

className

className: string = "AS2OneWayAgreement"

name

name: "Composite" = "Composite"

sendAgreement

sendAgreement: object

required

required: true = true

serializedName

serializedName: string = "sendAgreement"

type

type: object

className

className: string = "AS2OneWayAgreement"

name

name: "Composite" = "Composite"

Const AS2EnvelopeSettings

AS2EnvelopeSettings: object

The AS2 agreement envelope settings.

autogenerateFileName

autogenerateFileName: boolean

The value indicating whether to auto generate file name.

fileNameTemplate

fileNameTemplate: string

The template for file name.

messageContentType

messageContentType: string

The message content type.

suspendMessageOnFileNameGenerationError

suspendMessageOnFileNameGenerationError: boolean

The value indicating whether to suspend message on file name generation error.

transmitFileNameInMimeHeader

transmitFileNameInMimeHeader: boolean

The value indicating whether to transmit file name in mime header.

serializedName

serializedName: string = "AS2EnvelopeSettings"

type

type: object

className

className: string = "AS2EnvelopeSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

autogenerateFileName

autogenerateFileName: object

required

required: true = true

serializedName

serializedName: string = "autogenerateFileName"

type

type: object

name

name: "Boolean" = "Boolean"

fileNameTemplate

fileNameTemplate: object

required

required: true = true

serializedName

serializedName: string = "fileNameTemplate"

type

type: object

name

name: "String" = "String"

messageContentType

messageContentType: object

required

required: true = true

serializedName

serializedName: string = "messageContentType"

type

type: object

name

name: "String" = "String"

suspendMessageOnFileNameGenerationError

suspendMessageOnFileNameGenerationError: object

required

required: true = true

serializedName

serializedName: string = "suspendMessageOnFileNameGenerationError"

type

type: object

name

name: "Boolean" = "Boolean"

transmitFileNameInMimeHeader

transmitFileNameInMimeHeader: object

required

required: true = true

serializedName

serializedName: string = "transmitFileNameInMimeHeader"

type

type: object

name

name: "Boolean" = "Boolean"

Const AS2ErrorSettings

AS2ErrorSettings: object

The AS2 agreement error settings.

resendIfMDNNotReceived

resendIfMDNNotReceived: boolean

The value indicating whether to resend message If MDN is not received.

suspendDuplicateMessage

suspendDuplicateMessage: boolean

The value indicating whether to suspend duplicate message.

serializedName

serializedName: string = "AS2ErrorSettings"

type

type: object

className

className: string = "AS2ErrorSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

resendIfMDNNotReceived

resendIfMDNNotReceived: object

required

required: true = true

serializedName

serializedName: string = "resendIfMDNNotReceived"

type

type: object

name

name: "Boolean" = "Boolean"

suspendDuplicateMessage

suspendDuplicateMessage: object

required

required: true = true

serializedName

serializedName: string = "suspendDuplicateMessage"

type

type: object

name

name: "Boolean" = "Boolean"

Const AS2MdnSettings

AS2MdnSettings: object

The AS2 agreement mdn settings.

Optional dispositionNotificationTo

dispositionNotificationTo: undefined | string

The disposition notification to header value.

Optional mdnText

mdnText: undefined | string

The MDN text.

micHashingAlgorithm

micHashingAlgorithm: HashingAlgorithm

The signing or hashing algorithm. Possible values include: 'NotSpecified', 'None', 'MD5', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512'

needMDN

needMDN: boolean

The value indicating whether to send or request a MDN.

Optional receiptDeliveryUrl

receiptDeliveryUrl: undefined | string

The receipt delivery URL.

sendInboundMDNToMessageBox

sendInboundMDNToMessageBox: boolean

The value indicating whether to send inbound MDN to message box.

sendMDNAsynchronously

sendMDNAsynchronously: boolean

The value indicating whether to send the asynchronous MDN.

signMDN

signMDN: boolean

The value indicating whether the MDN needs to be signed or not.

signOutboundMDNIfOptional

signOutboundMDNIfOptional: boolean

The value indicating whether to sign the outbound MDN if optional.

serializedName

serializedName: string = "AS2MdnSettings"

type

type: object

className

className: string = "AS2MdnSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dispositionNotificationTo

dispositionNotificationTo: object

serializedName

serializedName: string = "dispositionNotificationTo"

type

type: object

name

name: "String" = "String"

mdnText

mdnText: object

serializedName

serializedName: string = "mdnText"

type

type: object

name

name: "String" = "String"

micHashingAlgorithm

micHashingAlgorithm: object

required

required: true = true

serializedName

serializedName: string = "micHashingAlgorithm"

type

type: object

name

name: "String" = "String"

needMDN

needMDN: object

required

required: true = true

serializedName

serializedName: string = "needMDN"

type

type: object

name

name: "Boolean" = "Boolean"

receiptDeliveryUrl

receiptDeliveryUrl: object

serializedName

serializedName: string = "receiptDeliveryUrl"

type

type: object

name

name: "String" = "String"

sendInboundMDNToMessageBox

sendInboundMDNToMessageBox: object

required

required: true = true

serializedName

serializedName: string = "sendInboundMDNToMessageBox"

type

type: object

name

name: "Boolean" = "Boolean"

sendMDNAsynchronously

sendMDNAsynchronously: object

required

required: true = true

serializedName

serializedName: string = "sendMDNAsynchronously"

type

type: object

name

name: "Boolean" = "Boolean"

signMDN

signMDN: object

required

required: true = true

serializedName

serializedName: string = "signMDN"

type

type: object

name

name: "Boolean" = "Boolean"

signOutboundMDNIfOptional

signOutboundMDNIfOptional: object

required

required: true = true

serializedName

serializedName: string = "signOutboundMDNIfOptional"

type

type: object

name

name: "Boolean" = "Boolean"

Const AS2MessageConnectionSettings

AS2MessageConnectionSettings: object

The AS2 agreement message connection settings.

ignoreCertificateNameMismatch

ignoreCertificateNameMismatch: boolean

The value indicating whether to ignore mismatch in certificate name.

keepHttpConnectionAlive

keepHttpConnectionAlive: boolean

The value indicating whether to keep the connection alive.

supportHttpStatusCodeContinue

supportHttpStatusCodeContinue: boolean

The value indicating whether to support HTTP status code 'CONTINUE'.

unfoldHttpHeaders

unfoldHttpHeaders: boolean

The value indicating whether to unfold the HTTP headers.

serializedName

serializedName: string = "AS2MessageConnectionSettings"

type

type: object

className

className: string = "AS2MessageConnectionSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ignoreCertificateNameMismatch

ignoreCertificateNameMismatch: object

required

required: true = true

serializedName

serializedName: string = "ignoreCertificateNameMismatch"

type

type: object

name

name: "Boolean" = "Boolean"

keepHttpConnectionAlive

keepHttpConnectionAlive: object

required

required: true = true

serializedName

serializedName: string = "keepHttpConnectionAlive"

type

type: object

name

name: "Boolean" = "Boolean"

supportHttpStatusCodeContinue

supportHttpStatusCodeContinue: object

required

required: true = true

serializedName

serializedName: string = "supportHttpStatusCodeContinue"

type

type: object

name

name: "Boolean" = "Boolean"

unfoldHttpHeaders

unfoldHttpHeaders: object

required

required: true = true

serializedName

serializedName: string = "unfoldHttpHeaders"

type

type: object

name

name: "Boolean" = "Boolean"

Const AS2OneWayAgreement

AS2OneWayAgreement: object

The integration account AS2 one-way agreement.

protocolSettings

protocolSettings: AS2ProtocolSettings

The AS2 protocol settings.

receiverBusinessIdentity

receiverBusinessIdentity: BusinessIdentity

The receiver business identity

senderBusinessIdentity

senderBusinessIdentity: BusinessIdentity

The sender business identity

serializedName

serializedName: string = "AS2OneWayAgreement"

type

type: object

className

className: string = "AS2OneWayAgreement"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

protocolSettings

protocolSettings: object

required

required: true = true

serializedName

serializedName: string = "protocolSettings"

type

type: object

className

className: string = "AS2ProtocolSettings"

name

name: "Composite" = "Composite"

receiverBusinessIdentity

receiverBusinessIdentity: object

required

required: true = true

serializedName

serializedName: string = "receiverBusinessIdentity"

type

type: object

className

className: string = "BusinessIdentity"

name

name: "Composite" = "Composite"

senderBusinessIdentity

senderBusinessIdentity: object

required

required: true = true

serializedName

serializedName: string = "senderBusinessIdentity"

type

type: object

className

className: string = "BusinessIdentity"

name

name: "Composite" = "Composite"

Const AS2ProtocolSettings

AS2ProtocolSettings: object

The AS2 agreement protocol settings.

acknowledgementConnectionSettings

acknowledgementConnectionSettings: AS2AcknowledgementConnectionSettings

The acknowledgement connection settings.

envelopeSettings

envelopeSettings: AS2EnvelopeSettings

The envelope settings.

errorSettings

errorSettings: AS2ErrorSettings

The error settings.

mdnSettings

mdnSettings: AS2MdnSettings

The MDN settings.

messageConnectionSettings

messageConnectionSettings: AS2MessageConnectionSettings

The message connection settings.

securitySettings

securitySettings: AS2SecuritySettings

The security settings.

validationSettings

validationSettings: AS2ValidationSettings

The validation settings.

serializedName

serializedName: string = "AS2ProtocolSettings"

type

type: object

className

className: string = "AS2ProtocolSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

acknowledgementConnectionSettings

acknowledgementConnectionSettings: object

required

required: true = true

serializedName

serializedName: string = "acknowledgementConnectionSettings"

type

type: object

className

className: string = "AS2AcknowledgementConnectionSettings"

name

name: "Composite" = "Composite"

envelopeSettings

envelopeSettings: object

required

required: true = true

serializedName

serializedName: string = "envelopeSettings"

type

type: object

className

className: string = "AS2EnvelopeSettings"

name

name: "Composite" = "Composite"

errorSettings

errorSettings: object

required

required: true = true

serializedName

serializedName: string = "errorSettings"

type

type: object

className

className: string = "AS2ErrorSettings"

name

name: "Composite" = "Composite"

mdnSettings

mdnSettings: object

required

required: true = true

serializedName

serializedName: string = "mdnSettings"

type

type: object

className

className: string = "AS2MdnSettings"

name

name: "Composite" = "Composite"

messageConnectionSettings

messageConnectionSettings: object

required

required: true = true

serializedName

serializedName: string = "messageConnectionSettings"

type

type: object

className

className: string = "AS2MessageConnectionSettings"

name

name: "Composite" = "Composite"

securitySettings

securitySettings: object

required

required: true = true

serializedName

serializedName: string = "securitySettings"

type

type: object

className

className: string = "AS2SecuritySettings"

name

name: "Composite" = "Composite"

validationSettings

validationSettings: object

required

required: true = true

serializedName

serializedName: string = "validationSettings"

type

type: object

className

className: string = "AS2ValidationSettings"

name

name: "Composite" = "Composite"

Const AS2SecuritySettings

AS2SecuritySettings: object

The AS2 agreement security settings.

enableNRRForInboundDecodedMessages

enableNRRForInboundDecodedMessages: boolean

The value indicating whether to enable NRR for inbound decoded messages.

enableNRRForInboundEncodedMessages

enableNRRForInboundEncodedMessages: boolean

The value indicating whether to enable NRR for inbound encoded messages.

enableNRRForInboundMDN

enableNRRForInboundMDN: boolean

The value indicating whether to enable NRR for inbound MDN.

enableNRRForOutboundDecodedMessages

enableNRRForOutboundDecodedMessages: boolean

The value indicating whether to enable NRR for outbound decoded messages.

enableNRRForOutboundEncodedMessages

enableNRRForOutboundEncodedMessages: boolean

The value indicating whether to enable NRR for outbound encoded messages.

enableNRRForOutboundMDN

enableNRRForOutboundMDN: boolean

The value indicating whether to enable NRR for outbound MDN.

Optional encryptionCertificateName

encryptionCertificateName: undefined | string

The name of the encryption certificate.

overrideGroupSigningCertificate

overrideGroupSigningCertificate: boolean

The value indicating whether to send or request a MDN.

Optional sha2AlgorithmFormat

sha2AlgorithmFormat: undefined | string

The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize.

Optional signingCertificateName

signingCertificateName: undefined | string

The name of the signing certificate.

serializedName

serializedName: string = "AS2SecuritySettings"

type

type: object

className

className: string = "AS2SecuritySettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

enableNRRForInboundDecodedMessages

enableNRRForInboundDecodedMessages: object

required

required: true = true

serializedName

serializedName: string = "enableNRRForInboundDecodedMessages"

type

type: object

name

name: "Boolean" = "Boolean"

enableNRRForInboundEncodedMessages

enableNRRForInboundEncodedMessages: object

required

required: true = true

serializedName

serializedName: string = "enableNRRForInboundEncodedMessages"

type

type: object

name

name: "Boolean" = "Boolean"

enableNRRForInboundMDN

enableNRRForInboundMDN: object

required

required: true = true

serializedName

serializedName: string = "enableNRRForInboundMDN"

type

type: object

name

name: "Boolean" = "Boolean"

enableNRRForOutboundDecodedMessages

enableNRRForOutboundDecodedMessages: object

required

required: true = true

serializedName

serializedName: string = "enableNRRForOutboundDecodedMessages"

type

type: object

name

name: "Boolean" = "Boolean"

enableNRRForOutboundEncodedMessages

enableNRRForOutboundEncodedMessages: object

required

required: true = true

serializedName

serializedName: string = "enableNRRForOutboundEncodedMessages"

type

type: object

name

name: "Boolean" = "Boolean"

enableNRRForOutboundMDN

enableNRRForOutboundMDN: object

required

required: true = true

serializedName

serializedName: string = "enableNRRForOutboundMDN"

type

type: object

name

name: "Boolean" = "Boolean"

encryptionCertificateName

encryptionCertificateName: object

serializedName

serializedName: string = "encryptionCertificateName"

type

type: object

name

name: "String" = "String"

overrideGroupSigningCertificate

overrideGroupSigningCertificate: object

required

required: true = true

serializedName

serializedName: string = "overrideGroupSigningCertificate"

type

type: object

name

name: "Boolean" = "Boolean"

sha2AlgorithmFormat

sha2AlgorithmFormat: object

serializedName

serializedName: string = "sha2AlgorithmFormat"

type

type: object

name

name: "String" = "String"

signingCertificateName

signingCertificateName: object

serializedName

serializedName: string = "signingCertificateName"

type

type: object

name

name: "String" = "String"

Const AS2ValidationSettings

AS2ValidationSettings: object

The AS2 agreement validation settings.

checkCertificateRevocationListOnReceive

checkCertificateRevocationListOnReceive: boolean

The value indicating whether to check for certificate revocation list on receive.

checkCertificateRevocationListOnSend

checkCertificateRevocationListOnSend: boolean

The value indicating whether to check for certificate revocation list on send.

checkDuplicateMessage

checkDuplicateMessage: boolean

The value indicating whether to check for duplicate message.

compressMessage

compressMessage: boolean

The value indicating whether the message has to be compressed.

encryptMessage

encryptMessage: boolean

The value indicating whether the message has to be encrypted.

encryptionAlgorithm

encryptionAlgorithm: EncryptionAlgorithm

The encryption algorithm. Possible values include: 'NotSpecified', 'None', 'DES3', 'RC2', 'AES128', 'AES192', 'AES256'

interchangeDuplicatesValidityDays

interchangeDuplicatesValidityDays: number

The number of days to look back for duplicate interchange.

overrideMessageProperties

overrideMessageProperties: boolean

The value indicating whether to override incoming message properties with those in agreement.

signMessage

signMessage: boolean

The value indicating whether the message has to be signed.

Optional signingAlgorithm

signingAlgorithm: SigningAlgorithm

The signing algorithm. Possible values include: 'NotSpecified', 'Default', 'SHA1', 'SHA2256', 'SHA2384', 'SHA2512'

serializedName

serializedName: string = "AS2ValidationSettings"

type

type: object

className

className: string = "AS2ValidationSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

checkCertificateRevocationListOnReceive

checkCertificateRevocationListOnReceive: object

required

required: true = true

serializedName

serializedName: string = "checkCertificateRevocationListOnReceive"

type

type: object

name

name: "Boolean" = "Boolean"

checkCertificateRevocationListOnSend

checkCertificateRevocationListOnSend: object

required

required: true = true

serializedName

serializedName: string = "checkCertificateRevocationListOnSend"

type

type: object

name

name: "Boolean" = "Boolean"

checkDuplicateMessage

checkDuplicateMessage: object

required

required: true = true

serializedName

serializedName: string = "checkDuplicateMessage"

type

type: object

name

name: "Boolean" = "Boolean"

compressMessage

compressMessage: object

required

required: true = true

serializedName

serializedName: string = "compressMessage"

type

type: object

name

name: "Boolean" = "Boolean"

encryptMessage

encryptMessage: object

required

required: true = true

serializedName

serializedName: string = "encryptMessage"

type

type: object

name

name: "Boolean" = "Boolean"

encryptionAlgorithm

encryptionAlgorithm: object

required

required: true = true

serializedName

serializedName: string = "encryptionAlgorithm"

type

type: object

name

name: "String" = "String"

interchangeDuplicatesValidityDays

interchangeDuplicatesValidityDays: object

required

required: true = true

serializedName

serializedName: string = "interchangeDuplicatesValidityDays"

type

type: object

name

name: "Number" = "Number"

overrideMessageProperties

overrideMessageProperties: object

required

required: true = true

serializedName

serializedName: string = "overrideMessageProperties"

type

type: object

name

name: "Boolean" = "Boolean"

signMessage

signMessage: object

required

required: true = true

serializedName

serializedName: string = "signMessage"

type

type: object

name

name: "Boolean" = "Boolean"

signingAlgorithm

signingAlgorithm: object

serializedName

serializedName: string = "signingAlgorithm"

type

type: object

name

name: "String" = "String"

Const AgreementContent

AgreementContent: object

The integration account agreement content.

Optional aS2

The AS2 agreement content.

Optional edifact

The EDIFACT agreement content.

Optional x12

The X12 agreement content.

serializedName

serializedName: string = "AgreementContent"

type

type: object

className

className: string = "AgreementContent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

aS2

aS2: object

serializedName

serializedName: string = "aS2"

type

type: object

className

className: string = "AS2AgreementContent"

name

name: "Composite" = "Composite"

edifact

edifact: object

serializedName

serializedName: string = "edifact"

type

type: object

className

className: string = "EdifactAgreementContent"

name

name: "Composite" = "Composite"

x12

x12: object

serializedName

serializedName: string = "x12"

type

type: object

className

className: string = "X12AgreementContent"

name

name: "Composite" = "Composite"

Const ArtifactContentPropertiesDefinition

ArtifactContentPropertiesDefinition: object

The artifact content properties definition.

Optional changedTime

changedTime: Date

The artifact changed time.

Optional content

content: any

Optional contentLink

contentLink: ContentLink

The content link.

Optional contentType

contentType: undefined | string

The content type.

Optional createdTime

createdTime: Date

The artifact creation time.

Optional metadata

metadata: any

serializedName

serializedName: string = "ArtifactContentPropertiesDefinition"

type

type: object

className

className: string = "ArtifactContentPropertiesDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

content

content: object

serializedName

serializedName: string = "content"

type

type: object

name

name: "Object" = "Object"

contentLink

contentLink: object

serializedName

serializedName: string = "contentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

contentType

contentType: object

serializedName

serializedName: string = "contentType"

type

type: object

name

name: "String" = "String"

Const ArtifactProperties

ArtifactProperties: object

The artifact properties definition.

Optional changedTime

changedTime: Date

The artifact changed time.

Optional createdTime

createdTime: Date

The artifact creation time.

Optional metadata

metadata: any

serializedName

serializedName: string = "ArtifactProperties"

type

type: object

className

className: string = "ArtifactProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changedTime

changedTime: object

serializedName

serializedName: string = "changedTime"

type

type: object

name

name: "DateTime" = "DateTime"

createdTime

createdTime: object

serializedName

serializedName: string = "createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Object" = "Object"

Const AssemblyCollection

AssemblyCollection: object
interface

A collection of assembly definitions.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "AssemblyCollection"

__@iterator

  • Iterator

    Returns IterableIterator<AssemblyDefinition>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<AssemblyDefinition>[]

      Additional items to add to the end of array1.

    Returns AssemblyDefinition[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns AssemblyDefinition[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, AssemblyDefinition]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: AssemblyDefinition, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: AssemblyDefinition

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): AssemblyDefinition[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns AssemblyDefinition[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): AssemblyDefinition | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns AssemblyDefinition | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: AssemblyDefinition

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: AssemblyDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: AssemblyDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns AssemblyDefinition | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns AssemblyDefinition

  • Parameters

    Returns AssemblyDefinition

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns AssemblyDefinition

  • Parameters

    Returns AssemblyDefinition

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns AssemblyDefinition[]

shift

  • Removes the first element from an array and returns it.

    Returns AssemblyDefinition | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns AssemblyDefinition[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns AssemblyDefinition[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: AssemblyDefinition[]

      Elements to insert into the array in place of the deleted elements.

    Returns AssemblyDefinition[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<AssemblyDefinition>

type

type: object

className

className: string = "AssemblyCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AssemblyDefinition"

name

name: "Composite" = "Composite"

Const AssemblyDefinition

AssemblyDefinition: object

The assembly definition.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The resource location.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

properties

properties: AssemblyProperties

The assembly properties.

Optional tags

tags: undefined | object

The resource tags.

serializedName

serializedName: string = "AssemblyDefinition"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "AssemblyDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "AssemblyProperties"

name

name: "Composite" = "Composite"

Const AssemblyProperties

AssemblyProperties: object

The assembly properties definition.

Optional assemblyCulture

assemblyCulture: undefined | string

The assembly culture.

assemblyName

assemblyName: string

The assembly name.

Optional assemblyPublicKeyToken

assemblyPublicKeyToken: undefined | string

The assembly public key token.

Optional assemblyVersion

assemblyVersion: undefined | string

The assembly version.

Optional changedTime

changedTime: Date

The artifact changed time.

Optional content

content: any

Optional contentLink

contentLink: ContentLink

The content link.

Optional contentType

contentType: undefined | string

The content type.

Optional createdTime

createdTime: Date

The artifact creation time.

Optional metadata

metadata: any

serializedName

serializedName: string = "AssemblyProperties"

type

type: object

className

className: string = "AssemblyProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

assemblyCulture

assemblyCulture: object

serializedName

serializedName: string = "assemblyCulture"

type

type: object

name

name: "String" = "String"

assemblyName

assemblyName: object

required

required: true = true

serializedName

serializedName: string = "assemblyName"

type

type: object

name

name: "String" = "String"

assemblyPublicKeyToken

assemblyPublicKeyToken: object

serializedName

serializedName: string = "assemblyPublicKeyToken"

type

type: object

name

name: "String" = "String"

assemblyVersion

assemblyVersion: object

serializedName

serializedName: string = "assemblyVersion"

type

type: object

name

name: "String" = "String"

Const AzureResourceErrorInfo

AzureResourceErrorInfo: object

The azure resource error info.

code

code: string

The error code.

Optional details

The error details.

message

message: string

The error message.

serializedName

serializedName: string = "AzureResourceErrorInfo"

type

type: object

className

className: string = "AzureResourceErrorInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

details

details: object

serializedName

serializedName: string = "details"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "AzureResourceErrorInfo"

name

name: "Composite" = "Composite"

message

message: object

required

required: true = true

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const B2BPartnerContent

B2BPartnerContent: object

The B2B partner content.

Optional businessIdentities

businessIdentities: BusinessIdentity[]

The list of partner business identities.

serializedName

serializedName: string = "B2BPartnerContent"

type

type: object

className

className: string = "B2BPartnerContent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

businessIdentities

businessIdentities: object

serializedName

serializedName: string = "businessIdentities"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BusinessIdentity"

name

name: "Composite" = "Composite"

Const BatchConfiguration

BatchConfiguration: object

The batch configuration resource definition.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The resource location.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

properties

The batch configuration properties.

Optional tags

tags: undefined | object

The resource tags.

serializedName

serializedName: string = "BatchConfiguration"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "BatchConfiguration"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

required

required: true = true

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "BatchConfigurationProperties"

name

name: "Composite" = "Composite"

Const BatchConfigurationCollection

BatchConfigurationCollection: object
interface

A collection of batch configurations.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "BatchConfigurationCollection"

__@iterator

  • Iterator

    Returns IterableIterator<BatchConfiguration>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<BatchConfiguration>[]

      Additional items to add to the end of array1.

    Returns BatchConfiguration[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns BatchConfiguration[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, BatchConfiguration]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: BatchConfiguration, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: BatchConfiguration

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): BatchConfiguration[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns BatchConfiguration[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): BatchConfiguration | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns BatchConfiguration | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: BatchConfiguration

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: BatchConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: BatchConfiguration

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns BatchConfiguration | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns BatchConfiguration

  • Parameters

    Returns BatchConfiguration

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns BatchConfiguration

  • Parameters

    Returns BatchConfiguration

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns BatchConfiguration[]

shift

  • Removes the first element from an array and returns it.

    Returns BatchConfiguration | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns BatchConfiguration[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns BatchConfiguration[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: BatchConfiguration[]

      Elements to insert into the array in place of the deleted elements.

    Returns BatchConfiguration[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<BatchConfiguration>

type

type: object

className

className: string = "BatchConfigurationCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "BatchConfiguration"

name

name: "Composite" = "Composite"

Const BatchConfigurationProperties

BatchConfigurationProperties: object

The batch configuration properties definition.

batchGroupName

batchGroupName: string

The name of the batch group.

Optional changedTime

changedTime: Date

The artifact changed time.

Optional createdTime

createdTime: Date

The artifact creation time.

Optional metadata

metadata: any

releaseCriteria

releaseCriteria: BatchReleaseCriteria

The batch release criteria.

serializedName

serializedName: string = "BatchConfigurationProperties"

type

type: object

className

className: string = "BatchConfigurationProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

batchGroupName

batchGroupName: object

required

required: true = true

serializedName

serializedName: string = "batchGroupName"

type

type: object

name

name: "String" = "String"

releaseCriteria

releaseCriteria: object

required

required: true = true

serializedName

serializedName: string = "releaseCriteria"

type

type: object

className

className: string = "BatchReleaseCriteria"

name

name: "Composite" = "Composite"

Const BatchReleaseCriteria

BatchReleaseCriteria: object

The batch release criteria.

Optional batchSize

batchSize: undefined | number

The batch size in bytes.

Optional messageCount

messageCount: undefined | number

The message count.

Optional recurrence

The recurrence.

serializedName

serializedName: string = "BatchReleaseCriteria"

type

type: object

className

className: string = "BatchReleaseCriteria"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

batchSize

batchSize: object

serializedName

serializedName: string = "batchSize"

type

type: object

name

name: "Number" = "Number"

messageCount

messageCount: object

serializedName

serializedName: string = "messageCount"

type

type: object

name

name: "Number" = "Number"

recurrence

recurrence: object

serializedName

serializedName: string = "recurrence"

type

type: object

className

className: string = "WorkflowTriggerRecurrence"

name

name: "Composite" = "Composite"

Const BusinessIdentity

BusinessIdentity: object

The integration account partner's business identity.

qualifier

qualifier: string

The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32

value

value: string

The user defined business identity value.

serializedName

serializedName: string = "BusinessIdentity"

type

type: object

className

className: string = "BusinessIdentity"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

qualifier

qualifier: object

required

required: true = true

serializedName

serializedName: string = "qualifier"

type

type: object

name

name: "String" = "String"

value

value: object

required

required: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const CallbackUrl

CallbackUrl: object

The callback url.

Optional value

value: undefined | string

The URL value.

serializedName

serializedName: string = "CallbackUrl"

type

type: object

className

className: string = "CallbackUrl"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ContentHash

ContentHash: object

The content hash.

Optional algorithm

algorithm: undefined | string

The algorithm of the content hash.

Optional value

value: undefined | string

The value of the content hash.

serializedName

serializedName: string = "ContentHash"

type

type: object

className

className: string = "ContentHash"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

algorithm

algorithm: object

serializedName

serializedName: string = "algorithm"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const ContentLink

ContentLink: object

The content link.

Optional contentHash

contentHash: ContentHash

The content hash.

Optional contentSize

contentSize: undefined | number

The content size.

Optional contentVersion

contentVersion: undefined | string

The content version.

Optional metadata

metadata: any

The metadata.

Optional uri

uri: undefined | string

The content link URI.

serializedName

serializedName: string = "ContentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

contentHash

contentHash: object

serializedName

serializedName: string = "contentHash"

type

type: object

className

className: string = "ContentHash"

name

name: "Composite" = "Composite"

contentSize

contentSize: object

serializedName

serializedName: string = "contentSize"

type

type: object

name

name: "Number" = "Number"

contentVersion

contentVersion: object

serializedName

serializedName: string = "contentVersion"

type

type: object

name

name: "String" = "String"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Object" = "Object"

uri

uri: object

serializedName

serializedName: string = "uri"

type

type: object

name

name: "String" = "String"

Const Correlation

Correlation: object

The correlation property.

Optional clientTrackingId

clientTrackingId: undefined | string

The client tracking id.

serializedName

serializedName: string = "Correlation"

type

type: object

className

className: string = "Correlation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientTrackingId

clientTrackingId: object

serializedName

serializedName: string = "clientTrackingId"

type

type: object

name

name: "String" = "String"

Const EdifactAcknowledgementSettings

EdifactAcknowledgementSettings: object

The Edifact agreement acknowledgement settings.

acknowledgementControlNumberLowerBound

acknowledgementControlNumberLowerBound: number

The acknowledgement control number lower bound.

Optional acknowledgementControlNumberPrefix

acknowledgementControlNumberPrefix: undefined | string

The acknowledgement control number prefix.

Optional acknowledgementControlNumberSuffix

acknowledgementControlNumberSuffix: undefined | string

The acknowledgement control number suffix.

acknowledgementControlNumberUpperBound

acknowledgementControlNumberUpperBound: number

The acknowledgement control number upper bound.

batchFunctionalAcknowledgements

batchFunctionalAcknowledgements: boolean

The value indicating whether to batch functional acknowledgements.

batchTechnicalAcknowledgements

batchTechnicalAcknowledgements: boolean

The value indicating whether to batch the technical acknowledgements.

needFunctionalAcknowledgement

needFunctionalAcknowledgement: boolean

The value indicating whether functional acknowledgement is needed.

needLoopForValidMessages

needLoopForValidMessages: boolean

The value indicating whether a loop is needed for valid messages.

needTechnicalAcknowledgement

needTechnicalAcknowledgement: boolean

The value indicating whether technical acknowledgement is needed.

rolloverAcknowledgementControlNumber

rolloverAcknowledgementControlNumber: boolean

The value indicating whether to rollover acknowledgement control number.

sendSynchronousAcknowledgement

sendSynchronousAcknowledgement: boolean

The value indicating whether to send synchronous acknowledgement.

serializedName

serializedName: string = "EdifactAcknowledgementSettings"

type

type: object

className

className: string = "EdifactAcknowledgementSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

acknowledgementControlNumberLowerBound

acknowledgementControlNumberLowerBound: object

required

required: true = true

serializedName

serializedName: string = "acknowledgementControlNumberLowerBound"

type

type: object

name

name: "Number" = "Number"

acknowledgementControlNumberPrefix

acknowledgementControlNumberPrefix: object

serializedName

serializedName: string = "acknowledgementControlNumberPrefix"

type

type: object

name

name: "String" = "String"

acknowledgementControlNumberSuffix

acknowledgementControlNumberSuffix: object

serializedName

serializedName: string = "acknowledgementControlNumberSuffix"

type

type: object

name

name: "String" = "String"

acknowledgementControlNumberUpperBound

acknowledgementControlNumberUpperBound: object

required

required: true = true

serializedName

serializedName: string = "acknowledgementControlNumberUpperBound"

type

type: object

name

name: "Number" = "Number"

batchFunctionalAcknowledgements

batchFunctionalAcknowledgements: object

required

required: true = true

serializedName

serializedName: string = "batchFunctionalAcknowledgements"

type

type: object

name

name: "Boolean" = "Boolean"

batchTechnicalAcknowledgements

batchTechnicalAcknowledgements: object

required

required: true = true

serializedName

serializedName: string = "batchTechnicalAcknowledgements"

type

type: object

name

name: "Boolean" = "Boolean"

needFunctionalAcknowledgement

needFunctionalAcknowledgement: object

required

required: true = true

serializedName

serializedName: string = "needFunctionalAcknowledgement"

type

type: object

name

name: "Boolean" = "Boolean"

needLoopForValidMessages

needLoopForValidMessages: object

required

required: true = true

serializedName

serializedName: string = "needLoopForValidMessages"

type

type: object

name

name: "Boolean" = "Boolean"

needTechnicalAcknowledgement

needTechnicalAcknowledgement: object

required

required: true = true

serializedName

serializedName: string = "needTechnicalAcknowledgement"

type

type: object

name

name: "Boolean" = "Boolean"

rolloverAcknowledgementControlNumber

rolloverAcknowledgementControlNumber: object

required

required: true = true

serializedName

serializedName: string = "rolloverAcknowledgementControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

sendSynchronousAcknowledgement

sendSynchronousAcknowledgement: object

required

required: true = true

serializedName

serializedName: string = "sendSynchronousAcknowledgement"

type

type: object

name

name: "Boolean" = "Boolean"

Const EdifactAgreementContent

EdifactAgreementContent: object

The Edifact agreement content.

receiveAgreement

receiveAgreement: EdifactOneWayAgreement

The EDIFACT one-way receive agreement.

sendAgreement

sendAgreement: EdifactOneWayAgreement

The EDIFACT one-way send agreement.

serializedName

serializedName: string = "EdifactAgreementContent"

type

type: object

className

className: string = "EdifactAgreementContent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

receiveAgreement

receiveAgreement: object

required

required: true = true

serializedName

serializedName: string = "receiveAgreement"

type

type: object

className

className: string = "EdifactOneWayAgreement"

name

name: "Composite" = "Composite"

sendAgreement

sendAgreement: object

required

required: true = true

serializedName

serializedName: string = "sendAgreement"

type

type: object

className

className: string = "EdifactOneWayAgreement"

name

name: "Composite" = "Composite"

Const EdifactDelimiterOverride

EdifactDelimiterOverride: object

The Edifact delimiter override settings.

componentSeparator

componentSeparator: number

The component separator.

dataElementSeparator

dataElementSeparator: number

The data element separator.

decimalPointIndicator

decimalPointIndicator: EdifactDecimalIndicator

The decimal point indicator. Possible values include: 'NotSpecified', 'Comma', 'Decimal'

Optional messageAssociationAssignedCode

messageAssociationAssignedCode: undefined | string

The message association assigned code.

Optional messageId

messageId: undefined | string

The message id.

Optional messageRelease

messageRelease: undefined | string

The message release.

Optional messageVersion

messageVersion: undefined | string

The message version.

releaseIndicator

releaseIndicator: number

The release indicator.

repetitionSeparator

repetitionSeparator: number

The repetition separator.

segmentTerminator

segmentTerminator: number

The segment terminator.

segmentTerminatorSuffix

segmentTerminatorSuffix: SegmentTerminatorSuffix

The segment terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF'

Optional targetNamespace

targetNamespace: undefined | string

The target namespace on which this delimiter settings has to be applied.

serializedName

serializedName: string = "EdifactDelimiterOverride"

type

type: object

className

className: string = "EdifactDelimiterOverride"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

componentSeparator

componentSeparator: object

required

required: true = true

serializedName

serializedName: string = "componentSeparator"

type

type: object

name

name: "Number" = "Number"

dataElementSeparator

dataElementSeparator: object

required

required: true = true

serializedName

serializedName: string = "dataElementSeparator"

type

type: object

name

name: "Number" = "Number"

decimalPointIndicator

decimalPointIndicator: object

required

required: true = true

serializedName

serializedName: string = "decimalPointIndicator"

type

type: object

allowedValues

allowedValues: string[] = ["NotSpecified","Comma","Decimal"]

name

name: "Enum" = "Enum"

messageAssociationAssignedCode

messageAssociationAssignedCode: object

serializedName

serializedName: string = "messageAssociationAssignedCode"

type

type: object

name

name: "String" = "String"

messageId

messageId: object

serializedName

serializedName: string = "messageId"

type

type: object

name

name: "String" = "String"

messageRelease

messageRelease: object

serializedName

serializedName: string = "messageRelease"

type

type: object

name

name: "String" = "String"

messageVersion

messageVersion: object

serializedName

serializedName: string = "messageVersion"

type

type: object

name

name: "String" = "String"

releaseIndicator

releaseIndicator: object

required

required: true = true

serializedName

serializedName: string = "releaseIndicator"

type

type: object

name

name: "Number" = "Number"

repetitionSeparator

repetitionSeparator: object

required

required: true = true

serializedName

serializedName: string = "repetitionSeparator"

type

type: object

name

name: "Number" = "Number"

segmentTerminator

segmentTerminator: object

required

required: true = true

serializedName

serializedName: string = "segmentTerminator"

type

type: object

name

name: "Number" = "Number"

segmentTerminatorSuffix

segmentTerminatorSuffix: object

required

required: true = true

serializedName

serializedName: string = "segmentTerminatorSuffix"

type

type: object

allowedValues

allowedValues: string[] = ["NotSpecified","None","CR","LF","CRLF"]

name

name: "Enum" = "Enum"

targetNamespace

targetNamespace: object

serializedName

serializedName: string = "targetNamespace"

type

type: object

name

name: "String" = "String"

Const EdifactEnvelopeOverride

EdifactEnvelopeOverride: object

The Edifact envelope override settings.

Optional applicationPassword

applicationPassword: undefined | string

The application password.

Optional associationAssignedCode

associationAssignedCode: undefined | string

The association assigned code.

Optional controllingAgencyCode

controllingAgencyCode: undefined | string

The controlling agency code.

Optional functionalGroupId

functionalGroupId: undefined | string

The functional group id.

Optional groupHeaderMessageRelease

groupHeaderMessageRelease: undefined | string

The group header message release.

Optional groupHeaderMessageVersion

groupHeaderMessageVersion: undefined | string

The group header message version.

Optional messageAssociationAssignedCode

messageAssociationAssignedCode: undefined | string

The message association assigned code.

Optional messageId

messageId: undefined | string

The message id on which this envelope settings has to be applied.

Optional messageRelease

messageRelease: undefined | string

The message release version on which this envelope settings has to be applied.

Optional messageVersion

messageVersion: undefined | string

The message version on which this envelope settings has to be applied.

Optional receiverApplicationId

receiverApplicationId: undefined | string

The receiver application id.

Optional receiverApplicationQualifier

receiverApplicationQualifier: undefined | string

The receiver application qualifier.

Optional senderApplicationId

senderApplicationId: undefined | string

The sender application id.

Optional senderApplicationQualifier

senderApplicationQualifier: undefined | string

The sender application qualifier.

Optional targetNamespace

targetNamespace: undefined | string

The target namespace on which this envelope settings has to be applied.

serializedName

serializedName: string = "EdifactEnvelopeOverride"

type

type: object

className

className: string = "EdifactEnvelopeOverride"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationPassword

applicationPassword: object

serializedName

serializedName: string = "applicationPassword"

type

type: object

name

name: "String" = "String"

associationAssignedCode

associationAssignedCode: object

serializedName

serializedName: string = "associationAssignedCode"

type

type: object

name

name: "String" = "String"

controllingAgencyCode

controllingAgencyCode: object

serializedName

serializedName: string = "controllingAgencyCode"

type

type: object

name

name: "String" = "String"

functionalGroupId

functionalGroupId: object

serializedName

serializedName: string = "functionalGroupId"

type

type: object

name

name: "String" = "String"

groupHeaderMessageRelease

groupHeaderMessageRelease: object

serializedName

serializedName: string = "groupHeaderMessageRelease"

type

type: object

name

name: "String" = "String"

groupHeaderMessageVersion

groupHeaderMessageVersion: object

serializedName

serializedName: string = "groupHeaderMessageVersion"

type

type: object

name

name: "String" = "String"

messageAssociationAssignedCode

messageAssociationAssignedCode: object

serializedName

serializedName: string = "messageAssociationAssignedCode"

type

type: object

name

name: "String" = "String"

messageId

messageId: object

serializedName

serializedName: string = "messageId"

type

type: object

name

name: "String" = "String"

messageRelease

messageRelease: object

serializedName

serializedName: string = "messageRelease"

type

type: object

name

name: "String" = "String"

messageVersion

messageVersion: object

serializedName

serializedName: string = "messageVersion"

type

type: object

name

name: "String" = "String"

receiverApplicationId

receiverApplicationId: object

serializedName

serializedName: string = "receiverApplicationId"

type

type: object

name

name: "String" = "String"

receiverApplicationQualifier

receiverApplicationQualifier: object

serializedName

serializedName: string = "receiverApplicationQualifier"

type

type: object

name

name: "String" = "String"

senderApplicationId

senderApplicationId: object

serializedName

serializedName: string = "senderApplicationId"

type

type: object

name

name: "String" = "String"

senderApplicationQualifier

senderApplicationQualifier: object

serializedName

serializedName: string = "senderApplicationQualifier"

type

type: object

name

name: "String" = "String"

targetNamespace

targetNamespace: object

serializedName

serializedName: string = "targetNamespace"

type

type: object

name

name: "String" = "String"

Const EdifactEnvelopeSettings

EdifactEnvelopeSettings: object

The Edifact agreement envelope settings.

Optional applicationReferenceId

applicationReferenceId: undefined | string

The application reference id.

applyDelimiterStringAdvice

applyDelimiterStringAdvice: boolean

The value indicating whether to apply delimiter string advice.

Optional communicationAgreementId

communicationAgreementId: undefined | string

The communication agreement id.

createGroupingSegments

createGroupingSegments: boolean

The value indicating whether to create grouping segments.

enableDefaultGroupHeaders

enableDefaultGroupHeaders: boolean

The value indicating whether to enable default group headers.

Optional functionalGroupId

functionalGroupId: undefined | string

The functional group id.

Optional groupApplicationPassword

groupApplicationPassword: undefined | string

The group application password.

Optional groupApplicationReceiverId

groupApplicationReceiverId: undefined | string

The group application receiver id.

Optional groupApplicationReceiverQualifier

groupApplicationReceiverQualifier: undefined | string

The group application receiver qualifier.

Optional groupApplicationSenderId

groupApplicationSenderId: undefined | string

The group application sender id.

Optional groupApplicationSenderQualifier

groupApplicationSenderQualifier: undefined | string

The group application sender qualifier.

Optional groupAssociationAssignedCode

groupAssociationAssignedCode: undefined | string

The group association assigned code.

groupControlNumberLowerBound

groupControlNumberLowerBound: number

The group control number lower bound.

Optional groupControlNumberPrefix

groupControlNumberPrefix: undefined | string

The group control number prefix.

Optional groupControlNumberSuffix

groupControlNumberSuffix: undefined | string

The group control number suffix.

groupControlNumberUpperBound

groupControlNumberUpperBound: number

The group control number upper bound.

Optional groupControllingAgencyCode

groupControllingAgencyCode: undefined | string

The group controlling agency code.

Optional groupMessageRelease

groupMessageRelease: undefined | string

The group message release.

Optional groupMessageVersion

groupMessageVersion: undefined | string

The group message version.

interchangeControlNumberLowerBound

interchangeControlNumberLowerBound: number

The interchange control number lower bound.

Optional interchangeControlNumberPrefix

interchangeControlNumberPrefix: undefined | string

The interchange control number prefix.

Optional interchangeControlNumberSuffix

interchangeControlNumberSuffix: undefined | string

The interchange control number suffix.

interchangeControlNumberUpperBound

interchangeControlNumberUpperBound: number

The interchange control number upper bound.

isTestInterchange

isTestInterchange: boolean

The value indicating whether the message is a test interchange.

overwriteExistingTransactionSetControlNumber

overwriteExistingTransactionSetControlNumber: boolean

The value indicating whether to overwrite existing transaction set control number.

Optional processingPriorityCode

processingPriorityCode: undefined | string

The processing priority code.

Optional receiverInternalIdentification

receiverInternalIdentification: undefined | string

The receiver internal identification.

Optional receiverInternalSubIdentification

receiverInternalSubIdentification: undefined | string

The receiver internal sub identification.

Optional receiverReverseRoutingAddress

receiverReverseRoutingAddress: undefined | string

The receiver reverse routing address.

Optional recipientReferencePasswordQualifier

recipientReferencePasswordQualifier: undefined | string

The recipient reference password qualifier.

Optional recipientReferencePasswordValue

recipientReferencePasswordValue: undefined | string

The recipient reference password value.

rolloverGroupControlNumber

rolloverGroupControlNumber: boolean

The value indicating whether to rollover group control number.

rolloverInterchangeControlNumber

rolloverInterchangeControlNumber: boolean

The value indicating whether to rollover interchange control number.

rolloverTransactionSetControlNumber

rolloverTransactionSetControlNumber: boolean

The value indicating whether to rollover transaction set control number.

Optional senderInternalIdentification

senderInternalIdentification: undefined | string

The sender internal identification.

Optional senderInternalSubIdentification

senderInternalSubIdentification: undefined | string

The sender internal sub identification.

Optional senderReverseRoutingAddress

senderReverseRoutingAddress: undefined | string

The sender reverse routing address.

transactionSetControlNumberLowerBound

transactionSetControlNumberLowerBound: number

The transaction set control number lower bound.

Optional transactionSetControlNumberPrefix

transactionSetControlNumberPrefix: undefined | string

The transaction set control number prefix.

Optional transactionSetControlNumberSuffix

transactionSetControlNumberSuffix: undefined | string

The transaction set control number suffix.

transactionSetControlNumberUpperBound

transactionSetControlNumberUpperBound: number

The transaction set control number upper bound.

serializedName

serializedName: string = "EdifactEnvelopeSettings"

type

type: object

className

className: string = "EdifactEnvelopeSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

applicationReferenceId

applicationReferenceId: object

serializedName

serializedName: string = "applicationReferenceId"

type

type: object

name

name: "String" = "String"

applyDelimiterStringAdvice

applyDelimiterStringAdvice: object

required

required: true = true

serializedName

serializedName: string = "applyDelimiterStringAdvice"

type

type: object

name

name: "Boolean" = "Boolean"

communicationAgreementId

communicationAgreementId: object

serializedName

serializedName: string = "communicationAgreementId"

type

type: object

name

name: "String" = "String"

createGroupingSegments

createGroupingSegments: object

required

required: true = true

serializedName

serializedName: string = "createGroupingSegments"

type

type: object

name

name: "Boolean" = "Boolean"

enableDefaultGroupHeaders

enableDefaultGroupHeaders: object

required

required: true = true

serializedName

serializedName: string = "enableDefaultGroupHeaders"

type

type: object

name

name: "Boolean" = "Boolean"

functionalGroupId

functionalGroupId: object

serializedName

serializedName: string = "functionalGroupId"

type

type: object

name

name: "String" = "String"

groupApplicationPassword

groupApplicationPassword: object

serializedName

serializedName: string = "groupApplicationPassword"

type

type: object

name

name: "String" = "String"

groupApplicationReceiverId

groupApplicationReceiverId: object

serializedName

serializedName: string = "groupApplicationReceiverId"

type

type: object

name

name: "String" = "String"

groupApplicationReceiverQualifier

groupApplicationReceiverQualifier: object

serializedName

serializedName: string = "groupApplicationReceiverQualifier"

type

type: object

name

name: "String" = "String"

groupApplicationSenderId

groupApplicationSenderId: object

serializedName

serializedName: string = "groupApplicationSenderId"

type

type: object

name

name: "String" = "String"

groupApplicationSenderQualifier

groupApplicationSenderQualifier: object

serializedName

serializedName: string = "groupApplicationSenderQualifier"

type

type: object

name

name: "String" = "String"

groupAssociationAssignedCode

groupAssociationAssignedCode: object

serializedName

serializedName: string = "groupAssociationAssignedCode"

type

type: object

name

name: "String" = "String"

groupControlNumberLowerBound

groupControlNumberLowerBound: object

required

required: true = true

serializedName

serializedName: string = "groupControlNumberLowerBound"

type

type: object

name

name: "Number" = "Number"

groupControlNumberPrefix

groupControlNumberPrefix: object

serializedName

serializedName: string = "groupControlNumberPrefix"

type

type: object

name

name: "String" = "String"

groupControlNumberSuffix

groupControlNumberSuffix: object

serializedName

serializedName: string = "groupControlNumberSuffix"

type

type: object

name

name: "String" = "String"

groupControlNumberUpperBound

groupControlNumberUpperBound: object

required

required: true = true

serializedName

serializedName: string = "groupControlNumberUpperBound"

type

type: object

name

name: "Number" = "Number"

groupControllingAgencyCode

groupControllingAgencyCode: object

serializedName

serializedName: string = "groupControllingAgencyCode"

type

type: object

name

name: "String" = "String"

groupMessageRelease

groupMessageRelease: object

serializedName

serializedName: string = "groupMessageRelease"

type

type: object

name

name: "String" = "String"

groupMessageVersion

groupMessageVersion: object

serializedName

serializedName: string = "groupMessageVersion"

type

type: object

name

name: "String" = "String"

interchangeControlNumberLowerBound

interchangeControlNumberLowerBound: object

required

required: true = true

serializedName

serializedName: string = "interchangeControlNumberLowerBound"

type

type: object

name

name: "Number" = "Number"

interchangeControlNumberPrefix

interchangeControlNumberPrefix: object

serializedName

serializedName: string = "interchangeControlNumberPrefix"

type

type: object

name

name: "String" = "String"

interchangeControlNumberSuffix

interchangeControlNumberSuffix: object

serializedName

serializedName: string = "interchangeControlNumberSuffix"

type

type: object

name

name: "String" = "String"

interchangeControlNumberUpperBound

interchangeControlNumberUpperBound: object

required

required: true = true

serializedName

serializedName: string = "interchangeControlNumberUpperBound"

type

type: object

name

name: "Number" = "Number"

isTestInterchange

isTestInterchange: object

required

required: true = true

serializedName

serializedName: string = "isTestInterchange"

type

type: object

name

name: "Boolean" = "Boolean"

overwriteExistingTransactionSetControlNumber

overwriteExistingTransactionSetControlNumber: object

required

required: true = true

serializedName

serializedName: string = "overwriteExistingTransactionSetControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

processingPriorityCode

processingPriorityCode: object

serializedName

serializedName: string = "processingPriorityCode"

type

type: object

name

name: "String" = "String"

receiverInternalIdentification

receiverInternalIdentification: object

serializedName

serializedName: string = "receiverInternalIdentification"

type

type: object

name

name: "String" = "String"

receiverInternalSubIdentification

receiverInternalSubIdentification: object

serializedName

serializedName: string = "receiverInternalSubIdentification"

type

type: object

name

name: "String" = "String"

receiverReverseRoutingAddress

receiverReverseRoutingAddress: object

serializedName

serializedName: string = "receiverReverseRoutingAddress"

type

type: object

name

name: "String" = "String"

recipientReferencePasswordQualifier

recipientReferencePasswordQualifier: object

serializedName

serializedName: string = "recipientReferencePasswordQualifier"

type

type: object

name

name: "String" = "String"

recipientReferencePasswordValue

recipientReferencePasswordValue: object

serializedName

serializedName: string = "recipientReferencePasswordValue"

type

type: object

name

name: "String" = "String"

rolloverGroupControlNumber

rolloverGroupControlNumber: object

required

required: true = true

serializedName

serializedName: string = "rolloverGroupControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

rolloverInterchangeControlNumber

rolloverInterchangeControlNumber: object

required

required: true = true

serializedName

serializedName: string = "rolloverInterchangeControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

rolloverTransactionSetControlNumber

rolloverTransactionSetControlNumber: object

required

required: true = true

serializedName

serializedName: string = "rolloverTransactionSetControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

senderInternalIdentification

senderInternalIdentification: object

serializedName

serializedName: string = "senderInternalIdentification"

type

type: object

name

name: "String" = "String"

senderInternalSubIdentification

senderInternalSubIdentification: object

serializedName

serializedName: string = "senderInternalSubIdentification"

type

type: object

name

name: "String" = "String"

senderReverseRoutingAddress

senderReverseRoutingAddress: object

serializedName

serializedName: string = "senderReverseRoutingAddress"

type

type: object

name

name: "String" = "String"

transactionSetControlNumberLowerBound

transactionSetControlNumberLowerBound: object

required

required: true = true

serializedName

serializedName: string = "transactionSetControlNumberLowerBound"

type

type: object

name

name: "Number" = "Number"

transactionSetControlNumberPrefix

transactionSetControlNumberPrefix: object

serializedName

serializedName: string = "transactionSetControlNumberPrefix"

type

type: object

name

name: "String" = "String"

transactionSetControlNumberSuffix

transactionSetControlNumberSuffix: object

serializedName

serializedName: string = "transactionSetControlNumberSuffix"

type

type: object

name

name: "String" = "String"

transactionSetControlNumberUpperBound

transactionSetControlNumberUpperBound: object

required

required: true = true

serializedName

serializedName: string = "transactionSetControlNumberUpperBound"

type

type: object

name

name: "Number" = "Number"

Const EdifactFramingSettings

EdifactFramingSettings: object

The Edifact agreement framing settings.

Optional characterEncoding

characterEncoding: undefined | string

The character encoding.

characterSet

characterSet: EdifactCharacterSet

The EDIFACT frame setting characterSet. Possible values include: 'NotSpecified', 'UNOB', 'UNOA', 'UNOC', 'UNOD', 'UNOE', 'UNOF', 'UNOG', 'UNOH', 'UNOI', 'UNOJ', 'UNOK', 'UNOX', 'UNOY', 'KECA'

componentSeparator

componentSeparator: number

The component separator.

dataElementSeparator

dataElementSeparator: number

The data element separator.

decimalPointIndicator

decimalPointIndicator: EdifactDecimalIndicator

The EDIFACT frame setting decimal indicator. Possible values include: 'NotSpecified', 'Comma', 'Decimal'

protocolVersion

protocolVersion: number

The protocol version.

releaseIndicator

releaseIndicator: number

The release indicator.

repetitionSeparator

repetitionSeparator: number

The repetition separator.

segmentTerminator

segmentTerminator: number

The segment terminator.

segmentTerminatorSuffix

segmentTerminatorSuffix: SegmentTerminatorSuffix

The EDIFACT frame setting segment terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF'

Optional serviceCodeListDirectoryVersion

serviceCodeListDirectoryVersion: undefined | string

The service code list directory version.

serializedName

serializedName: string = "EdifactFramingSettings"

type

type: object

className

className: string = "EdifactFramingSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

characterEncoding

characterEncoding: object

serializedName

serializedName: string = "characterEncoding"

type

type: object

name

name: "String" = "String"

characterSet

characterSet: object

required

required: true = true

serializedName

serializedName: string = "characterSet"

type

type: object

name

name: "String" = "String"

componentSeparator

componentSeparator: object

required

required: true = true

serializedName

serializedName: string = "componentSeparator"

type

type: object

name

name: "Number" = "Number"

dataElementSeparator

dataElementSeparator: object

required

required: true = true

serializedName

serializedName: string = "dataElementSeparator"

type

type: object

name

name: "Number" = "Number"

decimalPointIndicator

decimalPointIndicator: object

required

required: true = true

serializedName

serializedName: string = "decimalPointIndicator"

type

type: object

allowedValues

allowedValues: string[] = ["NotSpecified","Comma","Decimal"]

name

name: "Enum" = "Enum"

protocolVersion

protocolVersion: object

required

required: true = true

serializedName

serializedName: string = "protocolVersion"

type

type: object

name

name: "Number" = "Number"

releaseIndicator

releaseIndicator: object

required

required: true = true

serializedName

serializedName: string = "releaseIndicator"

type

type: object

name

name: "Number" = "Number"

repetitionSeparator

repetitionSeparator: object

required

required: true = true

serializedName

serializedName: string = "repetitionSeparator"

type

type: object

name

name: "Number" = "Number"

segmentTerminator

segmentTerminator: object

required

required: true = true

serializedName

serializedName: string = "segmentTerminator"

type

type: object

name

name: "Number" = "Number"

segmentTerminatorSuffix

segmentTerminatorSuffix: object

required

required: true = true

serializedName

serializedName: string = "segmentTerminatorSuffix"

type

type: object

allowedValues

allowedValues: string[] = ["NotSpecified","None","CR","LF","CRLF"]

name

name: "Enum" = "Enum"

serviceCodeListDirectoryVersion

serviceCodeListDirectoryVersion: object

serializedName

serializedName: string = "serviceCodeListDirectoryVersion"

type

type: object

name

name: "String" = "String"

Const EdifactMessageFilter

EdifactMessageFilter: object

The Edifact message filter for odata query.

messageFilterType

messageFilterType: MessageFilterType

The message filter type. Possible values include: 'NotSpecified', 'Include', 'Exclude'

serializedName

serializedName: string = "EdifactMessageFilter"

type

type: object

className

className: string = "EdifactMessageFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

messageFilterType

messageFilterType: object

required

required: true = true

serializedName

serializedName: string = "messageFilterType"

type

type: object

name

name: "String" = "String"

Const EdifactMessageIdentifier

EdifactMessageIdentifier: object

The Edifact message identifier.

messageId

messageId: string

The message id on which this envelope settings has to be applied.

serializedName

serializedName: string = "EdifactMessageIdentifier"

type

type: object

className

className: string = "EdifactMessageIdentifier"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

messageId

messageId: object

required

required: true = true

serializedName

serializedName: string = "messageId"

type

type: object

name

name: "String" = "String"

Const EdifactOneWayAgreement

EdifactOneWayAgreement: object

The Edifact one way agreement.

protocolSettings

protocolSettings: EdifactProtocolSettings

The EDIFACT protocol settings.

receiverBusinessIdentity

receiverBusinessIdentity: BusinessIdentity

The receiver business identity

senderBusinessIdentity

senderBusinessIdentity: BusinessIdentity

The sender business identity

serializedName

serializedName: string = "EdifactOneWayAgreement"

type

type: object

className

className: string = "EdifactOneWayAgreement"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

protocolSettings

protocolSettings: object

required

required: true = true

serializedName

serializedName: string = "protocolSettings"

type

type: object

className

className: string = "EdifactProtocolSettings"

name

name: "Composite" = "Composite"

receiverBusinessIdentity

receiverBusinessIdentity: object

required

required: true = true

serializedName

serializedName: string = "receiverBusinessIdentity"

type

type: object

className

className: string = "BusinessIdentity"

name

name: "Composite" = "Composite"

senderBusinessIdentity

senderBusinessIdentity: object

required

required: true = true

serializedName

serializedName: string = "senderBusinessIdentity"

type

type: object

className

className: string = "BusinessIdentity"

name

name: "Composite" = "Composite"

Const EdifactProcessingSettings

EdifactProcessingSettings: object

The Edifact agreement protocol settings.

createEmptyXmlTagsForTrailingSeparators

createEmptyXmlTagsForTrailingSeparators: boolean

The value indicating whether to create empty xml tags for trailing separators.

maskSecurityInfo

maskSecurityInfo: boolean

The value indicating whether to mask security information.

preserveInterchange

preserveInterchange: boolean

The value indicating whether to preserve interchange.

suspendInterchangeOnError

suspendInterchangeOnError: boolean

The value indicating whether to suspend interchange on error.

useDotAsDecimalSeparator

useDotAsDecimalSeparator: boolean

The value indicating whether to use dot as decimal separator.

serializedName

serializedName: string = "EdifactProcessingSettings"

type

type: object

className

className: string = "EdifactProcessingSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

createEmptyXmlTagsForTrailingSeparators

createEmptyXmlTagsForTrailingSeparators: object

required

required: true = true

serializedName

serializedName: string = "createEmptyXmlTagsForTrailingSeparators"

type

type: object

name

name: "Boolean" = "Boolean"

maskSecurityInfo

maskSecurityInfo: object

required

required: true = true

serializedName

serializedName: string = "maskSecurityInfo"

type

type: object

name

name: "Boolean" = "Boolean"

preserveInterchange

preserveInterchange: object

required

required: true = true

serializedName

serializedName: string = "preserveInterchange"

type

type: object

name

name: "Boolean" = "Boolean"

suspendInterchangeOnError

suspendInterchangeOnError: object

required

required: true = true

serializedName

serializedName: string = "suspendInterchangeOnError"

type

type: object

name

name: "Boolean" = "Boolean"

useDotAsDecimalSeparator

useDotAsDecimalSeparator: object

required

required: true = true

serializedName

serializedName: string = "useDotAsDecimalSeparator"

type

type: object

name

name: "Boolean" = "Boolean"

Const EdifactProtocolSettings

EdifactProtocolSettings: object

The Edifact agreement protocol settings.

acknowledgementSettings

acknowledgementSettings: EdifactAcknowledgementSettings

The EDIFACT acknowledgement settings.

Optional edifactDelimiterOverrides

edifactDelimiterOverrides: EdifactDelimiterOverride[]

The EDIFACT delimiter override settings.

Optional envelopeOverrides

envelopeOverrides: EdifactEnvelopeOverride[]

The EDIFACT envelope override settings.

envelopeSettings

envelopeSettings: EdifactEnvelopeSettings

The EDIFACT envelope settings.

framingSettings

framingSettings: EdifactFramingSettings

The EDIFACT framing settings.

messageFilter

messageFilter: EdifactMessageFilter

The EDIFACT message filter.

Optional messageFilterList

messageFilterList: EdifactMessageIdentifier[]

The EDIFACT message filter list.

processingSettings

processingSettings: EdifactProcessingSettings

The EDIFACT processing Settings.

schemaReferences

schemaReferences: EdifactSchemaReference[]

The EDIFACT schema references.

Optional validationOverrides

validationOverrides: EdifactValidationOverride[]

The EDIFACT validation override settings.

validationSettings

validationSettings: EdifactValidationSettings

The EDIFACT validation settings.

serializedName

serializedName: string = "EdifactProtocolSettings"

type

type: object

className

className: string = "EdifactProtocolSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

acknowledgementSettings

acknowledgementSettings: object

required

required: true = true

serializedName

serializedName: string = "acknowledgementSettings"

type

type: object

className

className: string = "EdifactAcknowledgementSettings"

name

name: "Composite" = "Composite"

edifactDelimiterOverrides

edifactDelimiterOverrides: object

serializedName

serializedName: string = "edifactDelimiterOverrides"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EdifactDelimiterOverride"

name

name: "Composite" = "Composite"

envelopeOverrides

envelopeOverrides: object

serializedName

serializedName: string = "envelopeOverrides"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EdifactEnvelopeOverride"

name

name: "Composite" = "Composite"

envelopeSettings

envelopeSettings: object

required

required: true = true

serializedName

serializedName: string = "envelopeSettings"

type

type: object

className

className: string = "EdifactEnvelopeSettings"

name

name: "Composite" = "Composite"

framingSettings

framingSettings: object

required

required: true = true

serializedName

serializedName: string = "framingSettings"

type

type: object

className

className: string = "EdifactFramingSettings"

name

name: "Composite" = "Composite"

messageFilter

messageFilter: object

required

required: true = true

serializedName

serializedName: string = "messageFilter"

type

type: object

className

className: string = "EdifactMessageFilter"

name

name: "Composite" = "Composite"

messageFilterList

messageFilterList: object

serializedName

serializedName: string = "messageFilterList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EdifactMessageIdentifier"

name

name: "Composite" = "Composite"

processingSettings

processingSettings: object

required

required: true = true

serializedName

serializedName: string = "processingSettings"

type

type: object

className

className: string = "EdifactProcessingSettings"

name

name: "Composite" = "Composite"

schemaReferences

schemaReferences: object

required

required: true = true

serializedName

serializedName: string = "schemaReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EdifactSchemaReference"

name

name: "Composite" = "Composite"

validationOverrides

validationOverrides: object

serializedName

serializedName: string = "validationOverrides"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "EdifactValidationOverride"

name

name: "Composite" = "Composite"

validationSettings

validationSettings: object

required

required: true = true

serializedName

serializedName: string = "validationSettings"

type

type: object

className

className: string = "EdifactValidationSettings"

name

name: "Composite" = "Composite"

Const EdifactSchemaReference

EdifactSchemaReference: object

The Edifact schema reference.

Optional associationAssignedCode

associationAssignedCode: undefined | string

The association assigned code.

messageId

messageId: string

The message id.

messageRelease

messageRelease: string

The message release version.

messageVersion

messageVersion: string

The message version.

schemaName

schemaName: string

The schema name.

Optional senderApplicationId

senderApplicationId: undefined | string

The sender application id.

Optional senderApplicationQualifier

senderApplicationQualifier: undefined | string

The sender application qualifier.

serializedName

serializedName: string = "EdifactSchemaReference"

type

type: object

className

className: string = "EdifactSchemaReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

associationAssignedCode

associationAssignedCode: object

serializedName

serializedName: string = "associationAssignedCode"

type

type: object

name

name: "String" = "String"

messageId

messageId: object

required

required: true = true

serializedName

serializedName: string = "messageId"

type

type: object

name

name: "String" = "String"

messageRelease

messageRelease: object

required

required: true = true

serializedName

serializedName: string = "messageRelease"

type

type: object

name

name: "String" = "String"

messageVersion

messageVersion: object

required

required: true = true

serializedName

serializedName: string = "messageVersion"

type

type: object

name

name: "String" = "String"

schemaName

schemaName: object

required

required: true = true

serializedName

serializedName: string = "schemaName"

type

type: object

name

name: "String" = "String"

senderApplicationId

senderApplicationId: object

serializedName

serializedName: string = "senderApplicationId"

type

type: object

name

name: "String" = "String"

senderApplicationQualifier

senderApplicationQualifier: object

serializedName

serializedName: string = "senderApplicationQualifier"

type

type: object

name

name: "String" = "String"

Const EdifactValidationOverride

EdifactValidationOverride: object

The Edifact validation override settings.

allowLeadingAndTrailingSpacesAndZeroes

allowLeadingAndTrailingSpacesAndZeroes: boolean

The value indicating whether to allow leading and trailing spaces and zeroes.

enforceCharacterSet

enforceCharacterSet: boolean

The value indicating whether to validate character Set.

messageId

messageId: string

The message id on which the validation settings has to be applied.

trailingSeparatorPolicy

trailingSeparatorPolicy: TrailingSeparatorPolicy

The trailing separator policy. Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', 'Mandatory'

trimLeadingAndTrailingSpacesAndZeroes

trimLeadingAndTrailingSpacesAndZeroes: boolean

The value indicating whether to trim leading and trailing spaces and zeroes.

validateEDITypes

validateEDITypes: boolean

The value indicating whether to validate EDI types.

validateXSDTypes

validateXSDTypes: boolean

The value indicating whether to validate XSD types.

serializedName

serializedName: string = "EdifactValidationOverride"

type

type: object

className

className: string = "EdifactValidationOverride"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowLeadingAndTrailingSpacesAndZeroes

allowLeadingAndTrailingSpacesAndZeroes: object

required

required: true = true

serializedName

serializedName: string = "allowLeadingAndTrailingSpacesAndZeroes"

type

type: object

name

name: "Boolean" = "Boolean"

enforceCharacterSet

enforceCharacterSet: object

required

required: true = true

serializedName

serializedName: string = "enforceCharacterSet"

type

type: object

name

name: "Boolean" = "Boolean"

messageId

messageId: object

required

required: true = true

serializedName

serializedName: string = "messageId"

type

type: object

name

name: "String" = "String"

trailingSeparatorPolicy

trailingSeparatorPolicy: object

required

required: true = true

serializedName

serializedName: string = "trailingSeparatorPolicy"

type

type: object

name

name: "String" = "String"

trimLeadingAndTrailingSpacesAndZeroes

trimLeadingAndTrailingSpacesAndZeroes: object

required

required: true = true

serializedName

serializedName: string = "trimLeadingAndTrailingSpacesAndZeroes"

type

type: object

name

name: "Boolean" = "Boolean"

validateEDITypes

validateEDITypes: object

required

required: true = true

serializedName

serializedName: string = "validateEDITypes"

type

type: object

name

name: "Boolean" = "Boolean"

validateXSDTypes

validateXSDTypes: object

required

required: true = true

serializedName

serializedName: string = "validateXSDTypes"

type

type: object

name

name: "Boolean" = "Boolean"

Const EdifactValidationSettings

EdifactValidationSettings: object

The Edifact agreement validation settings.

allowLeadingAndTrailingSpacesAndZeroes

allowLeadingAndTrailingSpacesAndZeroes: boolean

The value indicating whether to allow leading and trailing spaces and zeroes.

checkDuplicateGroupControlNumber

checkDuplicateGroupControlNumber: boolean

The value indicating whether to check for duplicate group control number.

checkDuplicateInterchangeControlNumber

checkDuplicateInterchangeControlNumber: boolean

The value indicating whether to check for duplicate interchange control number.

checkDuplicateTransactionSetControlNumber

checkDuplicateTransactionSetControlNumber: boolean

The value indicating whether to check for duplicate transaction set control number.

interchangeControlNumberValidityDays

interchangeControlNumberValidityDays: number

The validity period of interchange control number.

trailingSeparatorPolicy

trailingSeparatorPolicy: TrailingSeparatorPolicy

The trailing separator policy. Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', 'Mandatory'

trimLeadingAndTrailingSpacesAndZeroes

trimLeadingAndTrailingSpacesAndZeroes: boolean

The value indicating whether to trim leading and trailing spaces and zeroes.

validateCharacterSet

validateCharacterSet: boolean

The value indicating whether to validate character set in the message.

validateEDITypes

validateEDITypes: boolean

The value indicating whether to Whether to validate EDI types.

validateXSDTypes

validateXSDTypes: boolean

The value indicating whether to Whether to validate XSD types.

serializedName

serializedName: string = "EdifactValidationSettings"

type

type: object

className

className: string = "EdifactValidationSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowLeadingAndTrailingSpacesAndZeroes

allowLeadingAndTrailingSpacesAndZeroes: object

required

required: true = true

serializedName

serializedName: string = "allowLeadingAndTrailingSpacesAndZeroes"

type

type: object

name

name: "Boolean" = "Boolean"

checkDuplicateGroupControlNumber

checkDuplicateGroupControlNumber: object

required

required: true = true

serializedName

serializedName: string = "checkDuplicateGroupControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

checkDuplicateInterchangeControlNumber

checkDuplicateInterchangeControlNumber: object

required

required: true = true

serializedName

serializedName: string = "checkDuplicateInterchangeControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

checkDuplicateTransactionSetControlNumber

checkDuplicateTransactionSetControlNumber: object

required

required: true = true

serializedName

serializedName: string = "checkDuplicateTransactionSetControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

interchangeControlNumberValidityDays

interchangeControlNumberValidityDays: object

required

required: true = true

serializedName

serializedName: string = "interchangeControlNumberValidityDays"

type

type: object

name

name: "Number" = "Number"

trailingSeparatorPolicy

trailingSeparatorPolicy: object

required

required: true = true

serializedName

serializedName: string = "trailingSeparatorPolicy"

type

type: object

name

name: "String" = "String"

trimLeadingAndTrailingSpacesAndZeroes

trimLeadingAndTrailingSpacesAndZeroes: object

required

required: true = true

serializedName

serializedName: string = "trimLeadingAndTrailingSpacesAndZeroes"

type

type: object

name

name: "Boolean" = "Boolean"

validateCharacterSet

validateCharacterSet: object

required

required: true = true

serializedName

serializedName: string = "validateCharacterSet"

type

type: object

name

name: "Boolean" = "Boolean"

validateEDITypes

validateEDITypes: object

required

required: true = true

serializedName

serializedName: string = "validateEDITypes"

type

type: object

name

name: "Boolean" = "Boolean"

validateXSDTypes

validateXSDTypes: object

required

required: true = true

serializedName

serializedName: string = "validateXSDTypes"

type

type: object

name

name: "Boolean" = "Boolean"

Const ErrorInfo

ErrorInfo: object

The error info.

code

code: string

The error code.

serializedName

serializedName: string = "ErrorInfo"

type

type: object

className

className: string = "ErrorInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

required

required: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

Const ErrorProperties

ErrorProperties: object

Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.

Optional code

code: undefined | string

Error code.

Optional message

message: undefined | string

Error message indicating why the operation failed.

serializedName

serializedName: string = "ErrorProperties"

type

type: object

className

className: string = "ErrorProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const ErrorResponse

ErrorResponse: object

Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.

Optional error

The error properties.

serializedName

serializedName: string = "ErrorResponse"

type

type: object

className

className: string = "ErrorResponse"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorProperties"

name

name: "Composite" = "Composite"

Const Expression

Expression: object

An interface representing Expression.

Optional error

Optional subexpressions

subexpressions: Expression[]

Optional text

text: undefined | string

Optional value

value: any

serializedName

serializedName: string = "Expression"

type

type: object

className

className: string = "Expression"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "AzureResourceErrorInfo"

name

name: "Composite" = "Composite"

subexpressions

subexpressions: object

serializedName

serializedName: string = "subexpressions"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Expression"

name

name: "Composite" = "Composite"

text

text: object

serializedName

serializedName: string = "text"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Object" = "Object"

Const ExpressionRoot

ExpressionRoot: object

An interface representing ExpressionRoot.

Optional error

Optional path

path: undefined | string

The path.

Optional subexpressions

subexpressions: Expression[]

Optional text

text: undefined | string

Optional value

value: any

serializedName

serializedName: string = "ExpressionRoot"

type

type: object

className

className: string = "ExpressionRoot"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

path

path: object

serializedName

serializedName: string = "path"

type

type: object

name

name: "String" = "String"

Const ExpressionTraces

ExpressionTraces: object
interface

An interface representing the ExpressionTraces.

extends

Array

Array

Array: ArrayConstructor

Optional inputs

inputs: ExpressionRoot[]

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "ExpressionTraces"

__@iterator

  • Iterator

    Returns IterableIterator<ExpressionRoot>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<ExpressionRoot>[]

      Additional items to add to the end of array1.

    Returns ExpressionRoot[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns ExpressionRoot[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, ExpressionRoot]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: ExpressionRoot, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: ExpressionRoot

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): ExpressionRoot[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns ExpressionRoot[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): ExpressionRoot | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns ExpressionRoot | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: ExpressionRoot, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: ExpressionRoot

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: ExpressionRoot, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: ExpressionRoot

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: ExpressionRoot, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: ExpressionRoot

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns ExpressionRoot | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ExpressionRoot

  • Parameters

    Returns ExpressionRoot

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns ExpressionRoot

  • Parameters

    Returns ExpressionRoot

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns ExpressionRoot[]

shift

  • Removes the first element from an array and returns it.

    Returns ExpressionRoot | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): ExpressionRoot[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns ExpressionRoot[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns ExpressionRoot[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: ExpressionRoot[]

      Elements to insert into the array in place of the deleted elements.

    Returns ExpressionRoot[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: ExpressionRoot[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<ExpressionRoot>

type

type: object

className

className: string = "ExpressionTraces"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

inputs

inputs: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "ExpressionRoot"

name

name: "Composite" = "Composite"

Const GenerateUpgradedDefinitionParameters

GenerateUpgradedDefinitionParameters: object

The parameters to generate upgraded definition.

Optional targetSchemaVersion

targetSchemaVersion: undefined | string

The target schema version.

serializedName

serializedName: string = "GenerateUpgradedDefinitionParameters"

type

type: object

className

className: string = "GenerateUpgradedDefinitionParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

targetSchemaVersion

targetSchemaVersion: object

serializedName

serializedName: string = "targetSchemaVersion"

type

type: object

name

name: "String" = "String"

Const GetCallbackUrlParameters

GetCallbackUrlParameters: object

The callback url parameters.

Optional keyType

keyType: KeyType

The key type. Possible values include: 'NotSpecified', 'Primary', 'Secondary'

Optional notAfter

notAfter: Date

The expiry time.

serializedName

serializedName: string = "GetCallbackUrlParameters"

type

type: object

className

className: string = "GetCallbackUrlParameters"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyType

keyType: object

serializedName

serializedName: string = "keyType"

type

type: object

name

name: "String" = "String"

notAfter

notAfter: object

serializedName

serializedName: string = "notAfter"

type

type: object

name

name: "DateTime" = "DateTime"

Const IntegrationAccount

IntegrationAccount: object

The integration account.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The resource location.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

properties: any

The integration account properties.

Optional sku

The sku.

Optional tags

tags: undefined | object

The resource tags.

serializedName

serializedName: string = "IntegrationAccount"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IntegrationAccount"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

name

name: "Object" = "Object"

sku

sku: object

serializedName

serializedName: string = "sku"

type

type: object

className

className: string = "IntegrationAccountSku"

name

name: "Composite" = "Composite"

Const IntegrationAccountAgreement

IntegrationAccountAgreement: object

The integration account agreement.

agreementType

agreementType: AgreementType

The agreement type. Possible values include: 'NotSpecified', 'AS2', 'X12', 'Edifact'

Optional changedTime

changedTime: Date

The changed time. NOTE: This property will not be serialized. It can only be populated by the server.

content

The agreement content.

Optional createdTime

createdTime: Date

The created time. NOTE: This property will not be serialized. It can only be populated by the server.

guestIdentity

guestIdentity: BusinessIdentity

The business identity of the guest partner.

guestPartner

guestPartner: string

The integration account partner that is set as guest partner for this agreement.

hostIdentity

hostIdentity: BusinessIdentity

The business identity of the host partner.

hostPartner

hostPartner: string

The integration account partner that is set as host partner for this agreement.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The resource location.

Optional metadata

metadata: any

The metadata.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The resource tags.

serializedName

serializedName: string = "IntegrationAccountAgreement"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IntegrationAccountAgreement"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

agreementType

agreementType: object

required

required: true = true

serializedName

serializedName: string = "properties.agreementType"

type

type: object

allowedValues

allowedValues: string[] = ["NotSpecified","AS2","X12","Edifact"]

name

name: "Enum" = "Enum"

changedTime

changedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.changedTime"

type

type: object

name

name: "DateTime" = "DateTime"

content

content: object

required

required: true = true

serializedName

serializedName: string = "properties.content"

type

type: object

className

className: string = "AgreementContent"

name

name: "Composite" = "Composite"

createdTime

createdTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

guestIdentity

guestIdentity: object

required

required: true = true

serializedName

serializedName: string = "properties.guestIdentity"

type

type: object

className

className: string = "BusinessIdentity"

name

name: "Composite" = "Composite"

guestPartner

guestPartner: object

required

required: true = true

serializedName

serializedName: string = "properties.guestPartner"

type

type: object

name

name: "String" = "String"

hostIdentity

hostIdentity: object

required

required: true = true

serializedName

serializedName: string = "properties.hostIdentity"

type

type: object

className

className: string = "BusinessIdentity"

name

name: "Composite" = "Composite"

hostPartner

hostPartner: object

required

required: true = true

serializedName

serializedName: string = "properties.hostPartner"

type

type: object

name

name: "String" = "String"

metadata

metadata: object

serializedName

serializedName: string = "properties.metadata"

type

type: object

name

name: "Object" = "Object"

Const IntegrationAccountAgreementFilter

IntegrationAccountAgreementFilter: object

The integration account agreement filter for odata query.

agreementType

agreementType: AgreementType

The agreement type of integration account agreement. Possible values include: 'NotSpecified', 'AS2', 'X12', 'Edifact'

serializedName

serializedName: string = "IntegrationAccountAgreementFilter"

type

type: object

className

className: string = "IntegrationAccountAgreementFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

agreementType

agreementType: object

required

required: true = true

serializedName

serializedName: string = "agreementType"

type

type: object

allowedValues

allowedValues: string[] = ["NotSpecified","AS2","X12","Edifact"]

name

name: "Enum" = "Enum"

Const IntegrationAccountAgreementListResult

IntegrationAccountAgreementListResult: object
interface

The list of integration account agreements.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "IntegrationAccountAgreementListResult"

__@iterator

  • Iterator

    Returns IterableIterator<IntegrationAccountAgreement>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns IntegrationAccountAgreement[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IntegrationAccountAgreement[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IntegrationAccountAgreement]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IntegrationAccountAgreement

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns IntegrationAccountAgreement[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): IntegrationAccountAgreement | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns IntegrationAccountAgreement | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IntegrationAccountAgreement

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IntegrationAccountAgreement

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IntegrationAccountAgreement

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IntegrationAccountAgreement | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns IntegrationAccountAgreement[]

shift

  • Removes the first element from an array and returns it.

    Returns IntegrationAccountAgreement | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IntegrationAccountAgreement[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IntegrationAccountAgreement[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IntegrationAccountAgreement[]

      Elements to insert into the array in place of the deleted elements.

    Returns IntegrationAccountAgreement[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IntegrationAccountAgreement>

type

type: object

className

className: string = "IntegrationAccountAgreementListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IntegrationAccountAgreement"

name

name: "Composite" = "Composite"

Const IntegrationAccountCertificate

IntegrationAccountCertificate: object

The integration account certificate.

Optional changedTime

changedTime: Date

The changed time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdTime

createdTime: Date

The created time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional key

The key details in the key vault.

Optional location

location: undefined | string

The resource location.

Optional metadata

metadata: any

The metadata.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional publicCertificate

publicCertificate: undefined | string

The public certificate.

Optional tags

tags: undefined | object

The resource tags.

serializedName

serializedName: string = "IntegrationAccountCertificate"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IntegrationAccountCertificate"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changedTime

changedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.changedTime"

type

type: object

name

name: "DateTime" = "DateTime"

createdTime

createdTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

key

key: object

serializedName

serializedName: string = "properties.key"

type

type: object

className

className: string = "KeyVaultKeyReference"

name

name: "Composite" = "Composite"

metadata

metadata: object

serializedName

serializedName: string = "properties.metadata"

type

type: object

name

name: "Object" = "Object"

publicCertificate

publicCertificate: object

serializedName

serializedName: string = "properties.publicCertificate"

type

type: object

name

name: "String" = "String"

Const IntegrationAccountCertificateListResult

IntegrationAccountCertificateListResult: object
interface

The list of integration account certificates.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "IntegrationAccountCertificateListResult"

__@iterator

  • Iterator

    Returns IterableIterator<IntegrationAccountCertificate>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns IntegrationAccountCertificate[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IntegrationAccountCertificate[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IntegrationAccountCertificate]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IntegrationAccountCertificate

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    Returns IntegrationAccountCertificate[]

find

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IntegrationAccountCertificate

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IntegrationAccountCertificate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IntegrationAccountCertificate

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IntegrationAccountCertificate | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns IntegrationAccountCertificate[]

shift

  • Removes the first element from an array and returns it.

    Returns IntegrationAccountCertificate | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IntegrationAccountCertificate[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IntegrationAccountCertificate[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IntegrationAccountCertificate[]

      Elements to insert into the array in place of the deleted elements.

    Returns IntegrationAccountCertificate[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IntegrationAccountCertificate>

type

type: object

className

className: string = "IntegrationAccountCertificateListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IntegrationAccountCertificate"

name

name: "Composite" = "Composite"

Const IntegrationAccountListResult

IntegrationAccountListResult: object
interface

The list of integration accounts.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "IntegrationAccountListResult"

__@iterator

  • Iterator

    Returns IterableIterator<IntegrationAccount>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<IntegrationAccount>[]

      Additional items to add to the end of array1.

    Returns IntegrationAccount[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IntegrationAccount[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IntegrationAccount]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: IntegrationAccount, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IntegrationAccount

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): IntegrationAccount[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns IntegrationAccount[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): IntegrationAccount | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns IntegrationAccount | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IntegrationAccount

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IntegrationAccount

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IntegrationAccount

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IntegrationAccount | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns IntegrationAccount

  • Parameters

    Returns IntegrationAccount

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns IntegrationAccount

  • Parameters

    Returns IntegrationAccount

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns IntegrationAccount[]

shift

  • Removes the first element from an array and returns it.

    Returns IntegrationAccount | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IntegrationAccount[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IntegrationAccount[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IntegrationAccount[]

      Elements to insert into the array in place of the deleted elements.

    Returns IntegrationAccount[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IntegrationAccount>

type

type: object

className

className: string = "IntegrationAccountListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IntegrationAccount"

name

name: "Composite" = "Composite"

Const IntegrationAccountMap

IntegrationAccountMap: object

The integration account map.

Optional changedTime

changedTime: Date

The changed time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional content

content: undefined | string

The content.

Optional contentLink

contentLink: ContentLink

The content link. NOTE: This property will not be serialized. It can only be populated by the server.

Optional contentType

contentType: undefined | string

The content type.

Optional createdTime

createdTime: Date

The created time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The resource location.

mapType

mapType: MapType

The map type. Possible values include: 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', 'Liquid'

Optional metadata

metadata: any

The metadata.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional parametersSchema

The parameters schema of integration account map.

Optional tags

tags: undefined | object

The resource tags.

serializedName

serializedName: string = "IntegrationAccountMap"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IntegrationAccountMap"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changedTime

changedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.changedTime"

type

type: object

name

name: "DateTime" = "DateTime"

content

content: object

serializedName

serializedName: string = "properties.content"

type

type: object

name

name: "String" = "String"

contentLink

contentLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.contentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

contentType

contentType: object

serializedName

serializedName: string = "properties.contentType"

type

type: object

name

name: "String" = "String"

createdTime

createdTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

mapType

mapType: object

required

required: true = true

serializedName

serializedName: string = "properties.mapType"

type

type: object

name

name: "String" = "String"

metadata

metadata: object

serializedName

serializedName: string = "properties.metadata"

type

type: object

name

name: "Object" = "Object"

parametersSchema

parametersSchema: object

serializedName

serializedName: string = "properties.parametersSchema"

type

type: object

className

className: string = "IntegrationAccountMapPropertiesParametersSchema"

name

name: "Composite" = "Composite"

Const IntegrationAccountMapFilter

IntegrationAccountMapFilter: object

The integration account map filter for odata query.

mapType

mapType: MapType

The map type of integration account map. Possible values include: 'NotSpecified', 'Xslt', 'Xslt20', 'Xslt30', 'Liquid'

serializedName

serializedName: string = "IntegrationAccountMapFilter"

type

type: object

className

className: string = "IntegrationAccountMapFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

mapType

mapType: object

required

required: true = true

serializedName

serializedName: string = "mapType"

type

type: object

name

name: "String" = "String"

Const IntegrationAccountMapListResult

IntegrationAccountMapListResult: object
interface

The list of integration account maps.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "IntegrationAccountMapListResult"

__@iterator

  • Iterator

    Returns IterableIterator<IntegrationAccountMap>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns IntegrationAccountMap[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IntegrationAccountMap[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IntegrationAccountMap]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IntegrationAccountMap

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): IntegrationAccountMap[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns IntegrationAccountMap[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): IntegrationAccountMap | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns IntegrationAccountMap | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IntegrationAccountMap

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IntegrationAccountMap

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IntegrationAccountMap

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IntegrationAccountMap | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns IntegrationAccountMap

  • Parameters

    Returns IntegrationAccountMap

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns IntegrationAccountMap[]

shift

  • Removes the first element from an array and returns it.

    Returns IntegrationAccountMap | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IntegrationAccountMap[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IntegrationAccountMap[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IntegrationAccountMap[]

      Elements to insert into the array in place of the deleted elements.

    Returns IntegrationAccountMap[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IntegrationAccountMap>

type

type: object

className

className: string = "IntegrationAccountMapListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IntegrationAccountMap"

name

name: "Composite" = "Composite"

Const IntegrationAccountMapPropertiesParametersSchema

IntegrationAccountMapPropertiesParametersSchema: object

The parameters schema of integration account map.

Optional ref

ref: undefined | string

The reference name.

serializedName

serializedName: string = "IntegrationAccountMapProperties_parametersSchema"

type

type: object

className

className: string = "IntegrationAccountMapPropertiesParametersSchema"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

ref

ref: object

serializedName

serializedName: string = "ref"

type

type: object

name

name: "String" = "String"

Const IntegrationAccountPartner

IntegrationAccountPartner: object

The integration account partner.

Optional changedTime

changedTime: Date

The changed time. NOTE: This property will not be serialized. It can only be populated by the server.

content

The partner content.

Optional createdTime

createdTime: Date

The created time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The resource location.

Optional metadata

metadata: any

The metadata.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

partnerType

partnerType: PartnerType

The partner type. Possible values include: 'NotSpecified', 'B2B'

Optional tags

tags: undefined | object

The resource tags.

serializedName

serializedName: string = "IntegrationAccountPartner"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IntegrationAccountPartner"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changedTime

changedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.changedTime"

type

type: object

name

name: "DateTime" = "DateTime"

content

content: object

required

required: true = true

serializedName

serializedName: string = "properties.content"

type

type: object

className

className: string = "PartnerContent"

name

name: "Composite" = "Composite"

createdTime

createdTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

metadata

metadata: object

serializedName

serializedName: string = "properties.metadata"

type

type: object

name

name: "Object" = "Object"

partnerType

partnerType: object

required

required: true = true

serializedName

serializedName: string = "properties.partnerType"

type

type: object

name

name: "String" = "String"

Const IntegrationAccountPartnerFilter

IntegrationAccountPartnerFilter: object

The integration account partner filter for odata query.

partnerType

partnerType: PartnerType

The partner type of integration account partner. Possible values include: 'NotSpecified', 'B2B'

serializedName

serializedName: string = "IntegrationAccountPartnerFilter"

type

type: object

className

className: string = "IntegrationAccountPartnerFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

partnerType

partnerType: object

required

required: true = true

serializedName

serializedName: string = "partnerType"

type

type: object

name

name: "String" = "String"

Const IntegrationAccountPartnerListResult

IntegrationAccountPartnerListResult: object
interface

The list of integration account partners.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "IntegrationAccountPartnerListResult"

__@iterator

  • Iterator

    Returns IterableIterator<IntegrationAccountPartner>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns IntegrationAccountPartner[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IntegrationAccountPartner[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IntegrationAccountPartner]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IntegrationAccountPartner

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): IntegrationAccountPartner[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns IntegrationAccountPartner[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): IntegrationAccountPartner | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns IntegrationAccountPartner | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IntegrationAccountPartner

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IntegrationAccountPartner

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IntegrationAccountPartner

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IntegrationAccountPartner | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns IntegrationAccountPartner[]

shift

  • Removes the first element from an array and returns it.

    Returns IntegrationAccountPartner | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IntegrationAccountPartner[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IntegrationAccountPartner[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IntegrationAccountPartner[]

      Elements to insert into the array in place of the deleted elements.

    Returns IntegrationAccountPartner[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IntegrationAccountPartner>

type

type: object

className

className: string = "IntegrationAccountPartnerListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IntegrationAccountPartner"

name

name: "Composite" = "Composite"

Const IntegrationAccountSchema

IntegrationAccountSchema: object

The integration account schema.

Optional changedTime

changedTime: Date

The changed time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional content

content: undefined | string

The content.

Optional contentLink

contentLink: ContentLink

The content link. NOTE: This property will not be serialized. It can only be populated by the server.

Optional contentType

contentType: undefined | string

The content type.

Optional createdTime

createdTime: Date

The created time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional documentName

documentName: undefined | string

The document name.

Optional fileName

fileName: undefined | string

The file name.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The resource location.

Optional metadata

metadata: any

The metadata.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

schemaType

schemaType: SchemaType

The schema type. Possible values include: 'NotSpecified', 'Xml'

Optional tags

tags: undefined | object

The resource tags.

Optional targetNamespace

targetNamespace: undefined | string

The target namespace of the schema.

serializedName

serializedName: string = "IntegrationAccountSchema"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IntegrationAccountSchema"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changedTime

changedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.changedTime"

type

type: object

name

name: "DateTime" = "DateTime"

content

content: object

serializedName

serializedName: string = "properties.content"

type

type: object

name

name: "String" = "String"

contentLink

contentLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.contentLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

contentType

contentType: object

serializedName

serializedName: string = "properties.contentType"

type

type: object

name

name: "String" = "String"

createdTime

createdTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

documentName

documentName: object

serializedName

serializedName: string = "properties.documentName"

type

type: object

name

name: "String" = "String"

fileName

fileName: object

serializedName

serializedName: string = "properties.fileName"

type

type: object

name

name: "String" = "String"

metadata

metadata: object

serializedName

serializedName: string = "properties.metadata"

type

type: object

name

name: "Object" = "Object"

schemaType

schemaType: object

required

required: true = true

serializedName

serializedName: string = "properties.schemaType"

type

type: object

name

name: "String" = "String"

targetNamespace

targetNamespace: object

serializedName

serializedName: string = "properties.targetNamespace"

type

type: object

name

name: "String" = "String"

Const IntegrationAccountSchemaFilter

IntegrationAccountSchemaFilter: object

The integration account schema filter for odata query.

schemaType

schemaType: SchemaType

The schema type of integration account schema. Possible values include: 'NotSpecified', 'Xml'

serializedName

serializedName: string = "IntegrationAccountSchemaFilter"

type

type: object

className

className: string = "IntegrationAccountSchemaFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

schemaType

schemaType: object

required

required: true = true

serializedName

serializedName: string = "schemaType"

type

type: object

name

name: "String" = "String"

Const IntegrationAccountSchemaListResult

IntegrationAccountSchemaListResult: object
interface

The list of integration account schemas.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "IntegrationAccountSchemaListResult"

__@iterator

  • Iterator

    Returns IterableIterator<IntegrationAccountSchema>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns IntegrationAccountSchema[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IntegrationAccountSchema[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IntegrationAccountSchema]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IntegrationAccountSchema

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): IntegrationAccountSchema[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns IntegrationAccountSchema[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): IntegrationAccountSchema | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns IntegrationAccountSchema | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IntegrationAccountSchema

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IntegrationAccountSchema

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IntegrationAccountSchema

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IntegrationAccountSchema | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns IntegrationAccountSchema[]

shift

  • Removes the first element from an array and returns it.

    Returns IntegrationAccountSchema | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IntegrationAccountSchema[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IntegrationAccountSchema[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IntegrationAccountSchema[]

      Elements to insert into the array in place of the deleted elements.

    Returns IntegrationAccountSchema[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IntegrationAccountSchema>

type

type: object

className

className: string = "IntegrationAccountSchemaListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IntegrationAccountSchema"

name

name: "Composite" = "Composite"

Const IntegrationAccountSession

IntegrationAccountSession: object

The integration account session.

Optional changedTime

changedTime: Date

The changed time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional content

content: any

The session content.

Optional createdTime

createdTime: Date

The created time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The resource location.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The resource tags.

serializedName

serializedName: string = "IntegrationAccountSession"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "IntegrationAccountSession"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changedTime

changedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.changedTime"

type

type: object

name

name: "DateTime" = "DateTime"

content

content: object

serializedName

serializedName: string = "properties.content"

type

type: object

name

name: "Object" = "Object"

createdTime

createdTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const IntegrationAccountSessionFilter

IntegrationAccountSessionFilter: object

The integration account session filter.

changedTime

changedTime: Date

The changed time of integration account sessions.

serializedName

serializedName: string = "IntegrationAccountSessionFilter"

type

type: object

className

className: string = "IntegrationAccountSessionFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changedTime

changedTime: object

required

required: true = true

serializedName

serializedName: string = "changedTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const IntegrationAccountSessionListResult

IntegrationAccountSessionListResult: object
interface

The list of integration account sessions.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "IntegrationAccountSessionListResult"

__@iterator

  • Iterator

    Returns IterableIterator<IntegrationAccountSession>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns IntegrationAccountSession[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns IntegrationAccountSession[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, IntegrationAccountSession]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: IntegrationAccountSession

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): IntegrationAccountSession[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns IntegrationAccountSession[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): IntegrationAccountSession | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns IntegrationAccountSession | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: IntegrationAccountSession

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: IntegrationAccountSession

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: IntegrationAccountSession

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns IntegrationAccountSession | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns IntegrationAccountSession[]

shift

  • Removes the first element from an array and returns it.

    Returns IntegrationAccountSession | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns IntegrationAccountSession[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns IntegrationAccountSession[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: IntegrationAccountSession[]

      Elements to insert into the array in place of the deleted elements.

    Returns IntegrationAccountSession[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<IntegrationAccountSession>

type

type: object

className

className: string = "IntegrationAccountSessionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "IntegrationAccountSession"

name

name: "Composite" = "Composite"

Const IntegrationAccountSku

IntegrationAccountSku: object

The integration account sku.

name

The sku name. Possible values include: 'NotSpecified', 'Free', 'Basic', 'Standard'

serializedName

serializedName: string = "IntegrationAccountSku"

type

type: object

className

className: string = "IntegrationAccountSku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const JsonSchema

JsonSchema: object

The JSON schema.

Optional content

content: undefined | string

The JSON content.

Optional title

title: undefined | string

The JSON title.

serializedName

serializedName: string = "JsonSchema"

type

type: object

className

className: string = "JsonSchema"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

content

content: object

serializedName

serializedName: string = "content"

type

type: object

name

name: "String" = "String"

title

title: object

serializedName

serializedName: string = "title"

type

type: object

name

name: "String" = "String"

Const KeyVaultKey

KeyVaultKey: object

The key vault key.

Optional attributes

The key attributes.

Optional kid

kid: undefined | string

The key id.

serializedName

serializedName: string = "KeyVaultKey"

type

type: object

className

className: string = "KeyVaultKey"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

attributes

attributes: object

serializedName

serializedName: string = "attributes"

type

type: object

className

className: string = "KeyVaultKeyAttributes"

name

name: "Composite" = "Composite"

kid

kid: object

serializedName

serializedName: string = "kid"

type

type: object

name

name: "String" = "String"

Const KeyVaultKeyAttributes

KeyVaultKeyAttributes: object

The key attributes.

Optional created

created: undefined | number

When the key was created.

Optional enabled

enabled: undefined | false | true

Whether the key is enabled or not.

Optional updated

updated: undefined | number

When the key was updated.

serializedName

serializedName: string = "KeyVaultKey_attributes"

type

type: object

className

className: string = "KeyVaultKeyAttributes"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

created

created: object

serializedName

serializedName: string = "created"

type

type: object

name

name: "Number" = "Number"

enabled

enabled: object

serializedName

serializedName: string = "enabled"

type

type: object

name

name: "Boolean" = "Boolean"

updated

updated: object

serializedName

serializedName: string = "updated"

type

type: object

name

name: "Number" = "Number"

Const KeyVaultKeyCollection

KeyVaultKeyCollection: object
interface

Collection of key vault keys.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional skipToken

skipToken: undefined | string

The skip token.

serializedName

serializedName: string = "KeyVaultKeyCollection"

__@iterator

  • Iterator

    Returns IterableIterator<KeyVaultKey>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<KeyVaultKey>[]

      Additional items to add to the end of array1.

    Returns KeyVaultKey[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns KeyVaultKey[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, KeyVaultKey]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: KeyVaultKey, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: KeyVaultKey

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): KeyVaultKey[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns KeyVaultKey[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): KeyVaultKey | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns KeyVaultKey | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: KeyVaultKey, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: KeyVaultKey

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: KeyVaultKey, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: KeyVaultKey

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: KeyVaultKey, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: KeyVaultKey

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns KeyVaultKey | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: KeyVaultKey[]

      New elements of the Array.

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns KeyVaultKey

  • Parameters

    Returns KeyVaultKey

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): KeyVaultKey
  • reduceRight(callbackfn: function, initialValue: KeyVaultKey): KeyVaultKey
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns KeyVaultKey

  • Parameters

    Returns KeyVaultKey

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns KeyVaultKey[]

shift

  • Removes the first element from an array and returns it.

    Returns KeyVaultKey | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): KeyVaultKey[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns KeyVaultKey[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns KeyVaultKey[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: KeyVaultKey[]

      Elements to insert into the array in place of the deleted elements.

    Returns KeyVaultKey[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: KeyVaultKey[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<KeyVaultKey>

type

type: object

className

className: string = "KeyVaultKeyCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

skipToken

skipToken: object

serializedName

serializedName: string = "skipToken"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "KeyVaultKey"

name

name: "Composite" = "Composite"

Const KeyVaultKeyReference

KeyVaultKeyReference: object

The reference to the key vault key.

keyName

keyName: string

The private key name in key vault.

keyVault

The key vault reference.

Optional keyVersion

keyVersion: undefined | string

The private key version in key vault.

serializedName

serializedName: string = "KeyVaultKeyReference"

type

type: object

className

className: string = "KeyVaultKeyReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyName

keyName: object

required

required: true = true

serializedName

serializedName: string = "keyName"

type

type: object

name

name: "String" = "String"

keyVault

keyVault: object

required

required: true = true

serializedName

serializedName: string = "keyVault"

type

type: object

className

className: string = "KeyVaultKeyReferenceKeyVault"

name

name: "Composite" = "Composite"

keyVersion

keyVersion: object

serializedName

serializedName: string = "keyVersion"

type

type: object

name

name: "String" = "String"

Const KeyVaultKeyReferenceKeyVault

KeyVaultKeyReferenceKeyVault: object

The key vault reference.

Optional id

id: undefined | string

The resource id.

Optional name

name: undefined | string

The resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "KeyVaultKeyReference_keyVault"

Optional type

type: object

The resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "KeyVaultKeyReferenceKeyVault"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const KeyVaultReference

KeyVaultReference: object

The key vault reference.

Optional id

id: undefined | string

The resource id.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "KeyVaultReference"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "KeyVaultReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

Const ListKeyVaultKeysDefinition

ListKeyVaultKeysDefinition: object

The list key vault keys definition.

keyVault

The key vault reference.

Optional skipToken

skipToken: undefined | string

The skip token.

serializedName

serializedName: string = "ListKeyVaultKeysDefinition"

type

type: object

className

className: string = "ListKeyVaultKeysDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyVault

keyVault: object

required

required: true = true

serializedName

serializedName: string = "keyVault"

type

type: object

className

className: string = "KeyVaultReference"

name

name: "Composite" = "Composite"

skipToken

skipToken: object

serializedName

serializedName: string = "skipToken"

type

type: object

name

name: "String" = "String"

Const Operation

Operation: object

Logic REST API operation

Optional display

The object that represents the operation.

Optional name

name: undefined | string

Operation name: {provider}/{resource}/{operation}

serializedName

serializedName: string = "Operation"

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

display

display: object

serializedName

serializedName: string = "display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

name

name: object

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

Const OperationDisplay

OperationDisplay: object

The object that represents the operation.

Optional operation

operation: undefined | string

Operation type: Read, write, delete, etc.

Optional provider

provider: undefined | string

Service provider: Microsoft.Logic

Optional resource

resource: undefined | string

Resource on which the operation is performed: Profile, endpoint, etc.

serializedName

serializedName: string = "Operation_display"

type

type: object

className

className: string = "OperationDisplay"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

operation

operation: object

serializedName

serializedName: string = "operation"

type

type: object

name

name: "String" = "String"

provider

provider: object

serializedName

serializedName: string = "provider"

type

type: object

name

name: "String" = "String"

resource

resource: object

serializedName

serializedName: string = "resource"

type

type: object

name

name: "String" = "String"

Const OperationListResult

OperationListResult: object
interface

Result of the request to list Logic operations. It contains a list of operations and a URL link to get the next set of results.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

URL to get the next set of operation list results if there are any.

serializedName

serializedName: string = "OperationListResult"

__@iterator

  • Iterator

    Returns IterableIterator<Operation>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Operation>[]

      Additional items to add to the end of array1.

    Returns Operation[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Operation[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Operation]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Operation]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Operation, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Operation

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Operation[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Operation[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Operation | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns Operation | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Operation, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Operation

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Operation, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Operation

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Operation | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Operation[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Operation
  • reduce(callbackfn: function, initialValue: Operation): Operation
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Operation
  • reduceRight(callbackfn: function, initialValue: Operation): Operation
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Operation

  • Parameters

    Returns Operation

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Operation, currentIndex: number, array: Operation[]): U
        • Parameters

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Operation[]

shift

  • Removes the first element from an array and returns it.

    Returns Operation | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Operation[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Operation[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Operation[]
  • splice(start: number, deleteCount: number, ...items: Operation[]): Operation[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Operation[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Operation[]

      Elements to insert into the array in place of the deleted elements.

    Returns Operation[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Operation[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Operation>

type

type: object

className

className: string = "OperationListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Operation"

name

name: "Composite" = "Composite"

Const OperationResult

OperationResult: object

The operation result definition.

Optional code

code: undefined | string

The workflow scope repetition code.

Optional correlation

The correlation properties.

Optional endTime

endTime: Date

The end time of the workflow scope repetition.

Optional error

error: any

Optional inputs

inputs: any

Gets the inputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional inputsLink

inputsLink: ContentLink

Gets the link to inputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional iterationCount

iterationCount: undefined | number

Optional outputs

outputs: any

Gets the outputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputsLink

outputsLink: ContentLink

Gets the link to outputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional retryHistory

retryHistory: RetryHistory[]

Gets the retry histories.

Optional startTime

startTime: Date

The start time of the workflow scope repetition.

Optional status

The status of the workflow scope repetition. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored'

Optional trackedProperties

trackedProperties: any

Gets the tracked properties. NOTE: This property will not be serialized. It can only be populated by the server.

Optional trackingId

trackingId: undefined | string

Gets the tracking id. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "OperationResult"

type

type: object

className

className: string = "OperationResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

inputs

inputs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "inputs"

type

type: object

name

name: "Object" = "Object"

inputsLink

inputsLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "inputsLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

iterationCount

iterationCount: object

serializedName

serializedName: string = "iterationCount"

type

type: object

name

name: "Number" = "Number"

outputs

outputs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "outputs"

type

type: object

name

name: "Object" = "Object"

outputsLink

outputsLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "outputsLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

retryHistory

retryHistory: object

serializedName

serializedName: string = "retryHistory"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RetryHistory"

name

name: "Composite" = "Composite"

trackedProperties

trackedProperties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "trackedProperties"

type

type: object

name

name: "Object" = "Object"

trackingId

trackingId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "trackingId"

type

type: object

name

name: "String" = "String"

Const OperationResultProperties

OperationResultProperties: object

The run operation result properties.

Optional code

code: undefined | string

The workflow scope repetition code.

Optional correlation

The correlation properties.

Optional endTime

endTime: Date

The end time of the workflow scope repetition.

Optional error

error: any

Optional startTime

startTime: Date

The start time of the workflow scope repetition.

Optional status

The status of the workflow scope repetition. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored'

serializedName

serializedName: string = "OperationResultProperties"

type

type: object

className

className: string = "OperationResultProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

correlation

correlation: object

serializedName

serializedName: string = "correlation"

type

type: object

className

className: string = "RunActionCorrelation"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

name

name: "Object" = "Object"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const PartnerContent

PartnerContent: object

The integration account partner content.

Optional b2b

The B2B partner content.

serializedName

serializedName: string = "PartnerContent"

type

type: object

className

className: string = "PartnerContent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

b2b

b2b: object

serializedName

serializedName: string = "b2b"

type

type: object

className

className: string = "B2BPartnerContent"

name

name: "Composite" = "Composite"

Const RecurrenceSchedule

RecurrenceSchedule: object

The recurrence schedule.

Optional hours

hours: number[]

The hours.

Optional minutes

minutes: number[]

The minutes.

Optional monthDays

monthDays: number[]

The month days.

Optional monthlyOccurrences

monthlyOccurrences: RecurrenceScheduleOccurrence[]

The monthly occurrences.

Optional weekDays

weekDays: DaysOfWeek[]

The days of the week.

serializedName

serializedName: string = "RecurrenceSchedule"

type

type: object

className

className: string = "RecurrenceSchedule"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

hours

hours: object

serializedName

serializedName: string = "hours"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

minutes

minutes: object

serializedName

serializedName: string = "minutes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

monthDays

monthDays: object

serializedName

serializedName: string = "monthDays"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "Number" = "Number"

monthlyOccurrences

monthlyOccurrences: object

serializedName

serializedName: string = "monthlyOccurrences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RecurrenceScheduleOccurrence"

name

name: "Composite" = "Composite"

weekDays

weekDays: object

serializedName

serializedName: string = "weekDays"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

allowedValues

allowedValues: string[] = ["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]

name

name: "Enum" = "Enum"

Const RecurrenceScheduleOccurrence

RecurrenceScheduleOccurrence: object

The recurrence schedule occurrence.

Optional day

The day of the week. Possible values include: 'Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday'

Optional occurrence

occurrence: undefined | number

The occurrence.

serializedName

serializedName: string = "RecurrenceScheduleOccurrence"

type

type: object

className

className: string = "RecurrenceScheduleOccurrence"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

day

day: object

serializedName

serializedName: string = "day"

type

type: object

allowedValues

allowedValues: string[] = ["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"]

name

name: "Enum" = "Enum"

occurrence

occurrence: object

serializedName

serializedName: string = "occurrence"

type

type: object

name

name: "Number" = "Number"

Const RegenerateActionParameter

RegenerateActionParameter: object

The access key regenerate action content.

Optional keyType

keyType: KeyType

The key type. Possible values include: 'NotSpecified', 'Primary', 'Secondary'

serializedName

serializedName: string = "RegenerateActionParameter"

type

type: object

className

className: string = "RegenerateActionParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

keyType

keyType: object

serializedName

serializedName: string = "keyType"

type

type: object

name

name: "String" = "String"

Const RepetitionIndex

RepetitionIndex: object

The workflow run action repetition index.

itemIndex

itemIndex: number

The index.

Optional scopeName

scopeName: undefined | string

The scope.

serializedName

serializedName: string = "RepetitionIndex"

type

type: object

className

className: string = "RepetitionIndex"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

itemIndex

itemIndex: object

required

required: true = true

serializedName

serializedName: string = "itemIndex"

type

type: object

name

name: "Number" = "Number"

scopeName

scopeName: object

serializedName

serializedName: string = "scopeName"

type

type: object

name

name: "String" = "String"

Const Request

Request: object

A request.

Optional headers

headers: any

A list of all the headers attached to the request.

Optional method

method: undefined | string

The HTTP method used for the request.

Optional uri

uri: undefined | string

The destination for the request.

serializedName

serializedName: string = "Request"

type

type: object

className

className: string = "Request"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

headers

headers: object

serializedName

serializedName: string = "headers"

type

type: object

name

name: "Object" = "Object"

method

method: object

serializedName

serializedName: string = "method"

type

type: object

name

name: "String" = "String"

uri

uri: object

serializedName

serializedName: string = "uri"

type

type: object

name

name: "String" = "String"

Const RequestHistory

RequestHistory: object

The request history.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The resource location.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional properties

The request history properties.

Optional tags

tags: undefined | object

The resource tags.

serializedName

serializedName: string = "RequestHistory"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "RequestHistory"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

properties

properties: object

serializedName

serializedName: string = "properties"

type

type: object

className

className: string = "RequestHistoryProperties"

name

name: "Composite" = "Composite"

Const RequestHistoryListResult

RequestHistoryListResult: object
interface

The list of workflow request histories.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "RequestHistoryListResult"

__@iterator

  • Iterator

    Returns IterableIterator<RequestHistory>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<RequestHistory>[]

      Additional items to add to the end of array1.

    Returns RequestHistory[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns RequestHistory[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, RequestHistory]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: RequestHistory, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: RequestHistory

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): RequestHistory[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns RequestHistory[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): RequestHistory | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns RequestHistory | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: RequestHistory, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: RequestHistory

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: RequestHistory, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: RequestHistory

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: RequestHistory, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: RequestHistory

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns RequestHistory | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RequestHistory

  • Parameters

    Returns RequestHistory

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns RequestHistory

  • Parameters

    Returns RequestHistory

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns RequestHistory[]

shift

  • Removes the first element from an array and returns it.

    Returns RequestHistory | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): RequestHistory[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns RequestHistory[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns RequestHistory[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: RequestHistory[]

      Elements to insert into the array in place of the deleted elements.

    Returns RequestHistory[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: RequestHistory[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<RequestHistory>

type

type: object

className

className: string = "RequestHistoryListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RequestHistory"

name

name: "Composite" = "Composite"

Const RequestHistoryProperties

RequestHistoryProperties: object

The request history.

Optional endTime

endTime: Date

The time the request ended.

Optional request

request: Request

The request.

Optional response

response: Response

The response.

Optional startTime

startTime: Date

The time the request started.

serializedName

serializedName: string = "RequestHistoryProperties"

type

type: object

className

className: string = "RequestHistoryProperties"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

request

request: object

serializedName

serializedName: string = "request"

type

type: object

className

className: string = "Request"

name

name: "Composite" = "Composite"

response

response: object

serializedName

serializedName: string = "response"

type

type: object

className

className: string = "Response"

name

name: "Composite" = "Composite"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const Resource

Resource: object

The base resource type.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional location

location: undefined | string

The resource location.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional tags

tags: undefined | object

The resource tags.

serializedName

serializedName: string = "Resource"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Resource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

location

location: object

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

tags

tags: object

serializedName

serializedName: string = "tags"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const ResourceReference

ResourceReference: object

The resource reference.

Optional id

id: undefined | string

The resource id.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "ResourceReference"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "ResourceReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const Response

Response: object

A response.

Optional bodyLink

bodyLink: ContentLink

Details on the location of the body content.

Optional headers

headers: any

A list of all the headers attached to the response.

Optional statusCode

statusCode: undefined | number

The status code of the response.

serializedName

serializedName: string = "Response"

type

type: object

className

className: string = "Response"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

bodyLink

bodyLink: object

serializedName

serializedName: string = "bodyLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

headers

headers: object

serializedName

serializedName: string = "headers"

type

type: object

name

name: "Object" = "Object"

statusCode

statusCode: object

serializedName

serializedName: string = "statusCode"

type

type: object

name

name: "Number" = "Number"

Const RetryHistory

RetryHistory: object

The retry history.

Optional clientRequestId

clientRequestId: undefined | string

Gets the client request Id.

Optional code

code: undefined | string

Gets the status code.

Optional endTime

endTime: Date

Gets the end time.

Optional error

Gets the error response.

Optional serviceRequestId

serviceRequestId: undefined | string

Gets the service request Id.

Optional startTime

startTime: Date

Gets the start time.

serializedName

serializedName: string = "RetryHistory"

type

type: object

className

className: string = "RetryHistory"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientRequestId

clientRequestId: object

serializedName

serializedName: string = "clientRequestId"

type

type: object

name

name: "String" = "String"

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "ErrorResponse"

name

name: "Composite" = "Composite"

serviceRequestId

serviceRequestId: object

serializedName

serializedName: string = "serviceRequestId"

type

type: object

name

name: "String" = "String"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

Const RunActionCorrelation

RunActionCorrelation: object

The workflow run action correlation properties.

Optional actionTrackingId

actionTrackingId: undefined | string

The action tracking identifier.

Optional clientKeywords

clientKeywords: string[]

The client keywords.

Optional clientTrackingId

clientTrackingId: undefined | string

The client tracking identifier.

serializedName

serializedName: string = "RunActionCorrelation"

type

type: object

className

className: string = "RunActionCorrelation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

actionTrackingId

actionTrackingId: object

serializedName

serializedName: string = "actionTrackingId"

type

type: object

name

name: "String" = "String"

Const RunCorrelation

RunCorrelation: object

The correlation properties.

Optional clientKeywords

clientKeywords: string[]

The client keywords.

Optional clientTrackingId

clientTrackingId: undefined | string

The client tracking identifier.

serializedName

serializedName: string = "RunCorrelation"

type

type: object

className

className: string = "RunCorrelation"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

clientKeywords

clientKeywords: object

serializedName

serializedName: string = "clientKeywords"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

clientTrackingId

clientTrackingId: object

serializedName

serializedName: string = "clientTrackingId"

type

type: object

name

name: "String" = "String"

Const SetTriggerStateActionDefinition

SetTriggerStateActionDefinition: object

An interface representing SetTriggerStateActionDefinition.

source

serializedName

serializedName: string = "SetTriggerStateActionDefinition"

type

type: object

className

className: string = "SetTriggerStateActionDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

source

source: object

required

required: true = true

serializedName

serializedName: string = "source"

type

type: object

className

className: string = "WorkflowTrigger"

name

name: "Composite" = "Composite"

Const Sku

Sku: object

The sku type.

name

name: SkuName

The name. Possible values include: 'NotSpecified', 'Free', 'Shared', 'Basic', 'Standard', 'Premium'

Optional plan

The reference to plan.

serializedName

serializedName: string = "Sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

name

name: object

required

required: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

plan

plan: object

serializedName

serializedName: string = "plan"

type

type: object

className

className: string = "ResourceReference"

name

name: "Composite" = "Composite"

Const SubResource

SubResource: object

The sub resource type.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "SubResource"

type

type: object

className

className: string = "SubResource"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

id

id: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "id"

type

type: object

name

name: "String" = "String"

Const TrackingEvent

TrackingEvent: object

An interface representing TrackingEvent.

Optional error

eventLevel

eventLevel: EventLevel

Possible values include: 'LogAlways', 'Critical', 'Error', 'Warning', 'Informational', 'Verbose'

eventTime

eventTime: Date

recordType

recordType: TrackingRecordType

Possible values include: 'NotSpecified', 'Custom', 'AS2Message', 'AS2MDN', 'X12Interchange', 'X12FunctionalGroup', 'X12TransactionSet', 'X12InterchangeAcknowledgment', 'X12FunctionalGroupAcknowledgment', 'X12TransactionSetAcknowledgment', 'EdifactInterchange', 'EdifactFunctionalGroup', 'EdifactTransactionSet', 'EdifactInterchangeAcknowledgment', 'EdifactFunctionalGroupAcknowledgment', 'EdifactTransactionSetAcknowledgment'

serializedName

serializedName: string = "TrackingEvent"

type

type: object

className

className: string = "TrackingEvent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

serializedName

serializedName: string = "error"

type

type: object

className

className: string = "TrackingEventErrorInfo"

name

name: "Composite" = "Composite"

eventLevel

eventLevel: object

required

required: true = true

serializedName

serializedName: string = "eventLevel"

type

type: object

allowedValues

allowedValues: string[] = ["LogAlways","Critical","Error","Warning","Informational","Verbose"]

name

name: "Enum" = "Enum"

eventTime

eventTime: object

required

required: true = true

serializedName

serializedName: string = "eventTime"

type

type: object

name

name: "DateTime" = "DateTime"

recordType

recordType: object

required

required: true = true

serializedName

serializedName: string = "recordType"

type

type: object

name

name: "String" = "String"

Const TrackingEventErrorInfo

TrackingEventErrorInfo: object

An interface representing TrackingEventErrorInfo.

Optional code

code: undefined | string

Optional message

message: undefined | string

serializedName

serializedName: string = "TrackingEventErrorInfo"

type

type: object

className

className: string = "TrackingEventErrorInfo"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

message

message: object

serializedName

serializedName: string = "message"

type

type: object

name

name: "String" = "String"

Const TrackingEventsDefinition

TrackingEventsDefinition: object

An interface representing TrackingEventsDefinition.

events

events: TrackingEvent[]

sourceType

sourceType: string

Optional trackEventsOptions

trackEventsOptions: TrackEventsOperationOptions

Possible values include: 'None', 'DisableSourceInfoEnrich'

serializedName

serializedName: string = "TrackingEventsDefinition"

type

type: object

className

className: string = "TrackingEventsDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

events

events: object

required

required: true = true

serializedName

serializedName: string = "events"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "TrackingEvent"

name

name: "Composite" = "Composite"

sourceType

sourceType: object

required

required: true = true

serializedName

serializedName: string = "sourceType"

type

type: object

name

name: "String" = "String"

trackEventsOptions

trackEventsOptions: object

serializedName

serializedName: string = "trackEventsOptions"

type

type: object

name

name: "String" = "String"

Const Workflow

Workflow: object

The workflow type.

Optional accessEndpoint

accessEndpoint: undefined | string

Gets the access endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

Optional changedTime

changedTime: Date

Gets the changed time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdTime

createdTime: Date

Gets the created time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional definition

definition: any

The definition.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional integrationAccount

integrationAccount: ResourceReference

The integration account.

Optional location

location: undefined | string

The resource location.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: undefined | object

The parameters.

Optional provisioningState

provisioningState: WorkflowProvisioningState

Gets the provisioning state. Possible values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', 'Succeeded', 'Moving', 'Updating', 'Registering', 'Registered', 'Unregistering', 'Unregistered', 'Completed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional sku

sku: Sku

The sku.

Optional state

The state. Possible values include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended'

Optional tags

tags: undefined | object

The resource tags.

Optional version

version: undefined | string

Gets the version. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "Workflow"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "Workflow"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessEndpoint

accessEndpoint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.accessEndpoint"

type

type: object

name

name: "String" = "String"

changedTime

changedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.changedTime"

type

type: object

name

name: "DateTime" = "DateTime"

createdTime

createdTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

definition

definition: object

serializedName

serializedName: string = "properties.definition"

type

type: object

name

name: "Object" = "Object"

integrationAccount

integrationAccount: object

serializedName

serializedName: string = "properties.integrationAccount"

type

type: object

className

className: string = "ResourceReference"

name

name: "Composite" = "Composite"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "WorkflowParameter"

name

name: "Composite" = "Composite"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

sku

sku: object

serializedName

serializedName: string = "properties.sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

version

version: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.version"

type

type: object

name

name: "String" = "String"

Const WorkflowFilter

WorkflowFilter: object

The workflow filter.

Optional state

The state of workflows. Possible values include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended'

serializedName

serializedName: string = "WorkflowFilter"

type

type: object

className

className: string = "WorkflowFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const WorkflowListResult

WorkflowListResult: object
interface

The list of workflows.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "WorkflowListResult"

__@iterator

  • __@iterator(): IterableIterator<Workflow>
  • Iterator

    Returns IterableIterator<Workflow>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<Workflow>[]

      Additional items to add to the end of array1.

    Returns Workflow[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns Workflow[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • entries(): IterableIterator<[number, Workflow]>
  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, Workflow]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: Workflow, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: Workflow

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): Workflow[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns Workflow[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): Workflow | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    • predicate: function
    • Optional thisArg: any

    Returns Workflow | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: Workflow, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: Workflow

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: Workflow, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: Workflow

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: Workflow, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: Workflow

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns Workflow | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: Workflow[]

      New elements of the Array.

    Returns number

reduce

  • reduce(callbackfn: function): Workflow
  • reduce(callbackfn: function, initialValue: Workflow): Workflow
  • reduce<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    Returns Workflow

  • Parameters

    Returns Workflow

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Workflow, currentIndex: number, array: Workflow[]): U
        • Parameters

          • previousValue: U
          • currentValue: Workflow
          • currentIndex: number
          • array: Workflow[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): Workflow
  • reduceRight(callbackfn: function, initialValue: Workflow): Workflow
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    Returns Workflow

  • Parameters

    Returns Workflow

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

        • (previousValue: U, currentValue: Workflow, currentIndex: number, array: Workflow[]): U
        • Parameters

          • previousValue: U
          • currentValue: Workflow
          • currentIndex: number
          • array: Workflow[]

          Returns U

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns Workflow[]

shift

  • Removes the first element from an array and returns it.

    Returns Workflow | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): Workflow[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns Workflow[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • splice(start: number, deleteCount?: undefined | number): Workflow[]
  • splice(start: number, deleteCount: number, ...items: Workflow[]): Workflow[]
  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns Workflow[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: Workflow[]

      Elements to insert into the array in place of the deleted elements.

    Returns Workflow[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: Workflow[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<Workflow>

type

type: object

className

className: string = "WorkflowListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "Workflow"

name

name: "Composite" = "Composite"

Const WorkflowOutputParameter

WorkflowOutputParameter: object

The workflow output parameter.

Optional description

description: undefined | string

The description.

Optional error

error: any

Gets the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional metadata

metadata: any

The metadata.

Optional value

value: any

The value.

serializedName

serializedName: string = "WorkflowOutputParameter"

Optional type

type: object

The type. Possible values include: 'NotSpecified', 'String', 'SecureString', 'Int', 'Float', 'Bool', 'Array', 'Object', 'SecureObject'

className

className: string = "WorkflowOutputParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

error

error: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "error"

type

type: object

name

name: "Object" = "Object"

Const WorkflowParameter

WorkflowParameter: object

The workflow parameters.

Optional description

description: undefined | string

The description.

Optional metadata

metadata: any

The metadata.

Optional value

value: any

The value.

serializedName

serializedName: string = "WorkflowParameter"

Optional type

type: object

The type. Possible values include: 'NotSpecified', 'String', 'SecureString', 'Int', 'Float', 'Bool', 'Array', 'Object', 'SecureObject'

className

className: string = "WorkflowParameter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

description

description: object

serializedName

serializedName: string = "description"

type

type: object

name

name: "String" = "String"

metadata

metadata: object

serializedName

serializedName: string = "metadata"

type

type: object

name

name: "Object" = "Object"

type

type: object

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = "value"

type

type: object

name

name: "Object" = "Object"

Const WorkflowRun

WorkflowRun: object

The workflow run.

Optional code

code: undefined | string

Gets the code. NOTE: This property will not be serialized. It can only be populated by the server.

Optional correlation

correlation: Correlation

The run correlation.

Optional correlationId

correlationId: undefined | string

Gets the correlation id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional endTime

endTime: Date

Gets the end time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional error

error: any

Gets the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Gets the workflow run name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputs

outputs: undefined | object

Gets the outputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional response

Gets the response of the flow run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date

Gets the start time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

Gets the status. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored' NOTE: This property will not be serialized. It can only be populated by the server.

Optional trigger

Gets the fired trigger. NOTE: This property will not be serialized. It can only be populated by the server.

Optional waitEndTime

waitEndTime: Date

Gets the wait end time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional workflow

Gets the reference to workflow version. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkflowRun"

Optional type

type: object

Gets the workflow run type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "WorkflowRun"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.code"

type

type: object

name

name: "String" = "String"

correlation

correlation: object

serializedName

serializedName: string = "properties.correlation"

type

type: object

className

className: string = "Correlation"

name

name: "Composite" = "Composite"

correlationId

correlationId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.correlationId"

type

type: object

name

name: "String" = "String"

endTime

endTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

error

error: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.error"

type

type: object

name

name: "Object" = "Object"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

outputs

outputs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.outputs"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "WorkflowOutputParameter"

name

name: "Composite" = "Composite"

response

response: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.response"

type

type: object

className

className: string = "WorkflowRunTrigger"

name

name: "Composite" = "Composite"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

trigger

trigger: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.trigger"

type

type: object

className

className: string = "WorkflowRunTrigger"

name

name: "Composite" = "Composite"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

waitEndTime

waitEndTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.waitEndTime"

type

type: object

name

name: "DateTime" = "DateTime"

workflow

workflow: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.workflow"

type

type: object

className

className: string = "ResourceReference"

name

name: "Composite" = "Composite"

Const WorkflowRunAction

WorkflowRunAction: object

The workflow run action.

Optional code

code: undefined | string

Gets the code. NOTE: This property will not be serialized. It can only be populated by the server.

Optional correlation

correlation: Correlation

The correlation properties.

Optional endTime

endTime: Date

Gets the end time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional error

error: any

Gets the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional inputsLink

inputsLink: ContentLink

Gets the link to inputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Gets the workflow run action name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputsLink

outputsLink: ContentLink

Gets the link to outputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional retryHistory

retryHistory: RetryHistory[]

Gets the retry histories.

Optional startTime

startTime: Date

Gets the start time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

Gets the status. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored' NOTE: This property will not be serialized. It can only be populated by the server.

Optional trackedProperties

trackedProperties: any

Gets the tracked properties. NOTE: This property will not be serialized. It can only be populated by the server.

Optional trackingId

trackingId: undefined | string

Gets the tracking id. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkflowRunAction"

Optional type

type: object

Gets the workflow run action type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "WorkflowRunAction"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.code"

type

type: object

name

name: "String" = "String"

correlation

correlation: object

serializedName

serializedName: string = "properties.correlation"

type

type: object

className

className: string = "Correlation"

name

name: "Composite" = "Composite"

endTime

endTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

error

error: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.error"

type

type: object

name

name: "Object" = "Object"

inputsLink

inputsLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.inputsLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

outputsLink

outputsLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.outputsLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

retryHistory

retryHistory: object

serializedName

serializedName: string = "properties.retryHistory"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RetryHistory"

name

name: "Composite" = "Composite"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

trackedProperties

trackedProperties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.trackedProperties"

type

type: object

name

name: "Object" = "Object"

trackingId

trackingId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.trackingId"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const WorkflowRunActionFilter

WorkflowRunActionFilter: object

The workflow run action filter.

Optional status

The status of workflow run action. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored'

serializedName

serializedName: string = "WorkflowRunActionFilter"

type

type: object

className

className: string = "WorkflowRunActionFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const WorkflowRunActionListResult

WorkflowRunActionListResult: object
interface

The list of workflow run actions.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "WorkflowRunActionListResult"

__@iterator

  • Iterator

    Returns IterableIterator<WorkflowRunAction>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<WorkflowRunAction>[]

      Additional items to add to the end of array1.

    Returns WorkflowRunAction[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns WorkflowRunAction[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, WorkflowRunAction]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: WorkflowRunAction, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: WorkflowRunAction

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): WorkflowRunAction[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns WorkflowRunAction[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): WorkflowRunAction | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns WorkflowRunAction | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: WorkflowRunAction, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: WorkflowRunAction

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: WorkflowRunAction

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: WorkflowRunAction, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: WorkflowRunAction

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns WorkflowRunAction | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns WorkflowRunAction

  • Parameters

    Returns WorkflowRunAction

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns WorkflowRunAction

  • Parameters

    Returns WorkflowRunAction

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns WorkflowRunAction[]

shift

  • Removes the first element from an array and returns it.

    Returns WorkflowRunAction | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns WorkflowRunAction[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns WorkflowRunAction[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: WorkflowRunAction[]

      Elements to insert into the array in place of the deleted elements.

    Returns WorkflowRunAction[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<WorkflowRunAction>

type

type: object

className

className: string = "WorkflowRunActionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WorkflowRunAction"

name

name: "Composite" = "Composite"

Const WorkflowRunActionRepetitionDefinition

WorkflowRunActionRepetitionDefinition: object

The workflow run action repetition definition.

Optional code

code: undefined | string

The workflow scope repetition code.

Optional correlation

The correlation properties.

Optional endTime

endTime: Date

The end time of the workflow scope repetition.

Optional error

error: any

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional inputs

inputs: any

Gets the inputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional inputsLink

inputsLink: ContentLink

Gets the link to inputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional iterationCount

iterationCount: undefined | number

Optional location

location: undefined | string

The resource location.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputs

outputs: any

Gets the outputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputsLink

outputsLink: ContentLink

Gets the link to outputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional repetitionIndexes

repetitionIndexes: RepetitionIndex[]

The repetition indexes.

Optional retryHistory

retryHistory: RetryHistory[]

Gets the retry histories.

Optional startTime

startTime: Date

The start time of the workflow scope repetition.

Optional status

The status of the workflow scope repetition. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored'

Optional tags

tags: undefined | object

The resource tags.

Optional trackedProperties

trackedProperties: any

Gets the tracked properties. NOTE: This property will not be serialized. It can only be populated by the server.

Optional trackingId

trackingId: undefined | string

Gets the tracking id. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkflowRunActionRepetitionDefinition"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "WorkflowRunActionRepetitionDefinition"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

serializedName

serializedName: string = "properties.code"

type

type: object

name

name: "String" = "String"

correlation

correlation: object

serializedName

serializedName: string = "properties.correlation"

type

type: object

className

className: string = "RunActionCorrelation"

name

name: "Composite" = "Composite"

endTime

endTime: object

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

error

error: object

serializedName

serializedName: string = "properties.error"

type

type: object

name

name: "Object" = "Object"

inputs

inputs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.inputs"

type

type: object

name

name: "Object" = "Object"

inputsLink

inputsLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.inputsLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

iterationCount

iterationCount: object

serializedName

serializedName: string = "properties.iterationCount"

type

type: object

name

name: "Number" = "Number"

outputs

outputs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.outputs"

type

type: object

name

name: "Object" = "Object"

outputsLink

outputsLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.outputsLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

repetitionIndexes

repetitionIndexes: object

serializedName

serializedName: string = "properties.repetitionIndexes"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RepetitionIndex"

name

name: "Composite" = "Composite"

retryHistory

retryHistory: object

serializedName

serializedName: string = "properties.retryHistory"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "RetryHistory"

name

name: "Composite" = "Composite"

startTime

startTime: object

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

trackedProperties

trackedProperties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.trackedProperties"

type

type: object

name

name: "Object" = "Object"

trackingId

trackingId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.trackingId"

type

type: object

name

name: "String" = "String"

Const WorkflowRunActionRepetitionDefinitionCollection

WorkflowRunActionRepetitionDefinitionCollection: object
interface

A collection of workflow run action repetitions.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

serializedName

serializedName: string = "WorkflowRunActionRepetitionDefinitionCollection"

__@iterator

  • Iterator

    Returns IterableIterator<WorkflowRunActionRepetitionDefinition>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns WorkflowRunActionRepetitionDefinition[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns WorkflowRunActionRepetitionDefinition[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, WorkflowRunActionRepetitionDefinition]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: WorkflowRunActionRepetitionDefinition

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

find

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: WorkflowRunActionRepetitionDefinition

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: WorkflowRunActionRepetitionDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: WorkflowRunActionRepetitionDefinition

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns WorkflowRunActionRepetitionDefinition | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns WorkflowRunActionRepetitionDefinition[]

shift

  • Removes the first element from an array and returns it.

    Returns WorkflowRunActionRepetitionDefinition | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns WorkflowRunActionRepetitionDefinition[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns WorkflowRunActionRepetitionDefinition[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: WorkflowRunActionRepetitionDefinition[]

      Elements to insert into the array in place of the deleted elements.

    Returns WorkflowRunActionRepetitionDefinition[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<WorkflowRunActionRepetitionDefinition>

type

type: object

className

className: string = "WorkflowRunActionRepetitionDefinitionCollection"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WorkflowRunActionRepetitionDefinition"

name

name: "Composite" = "Composite"

Const WorkflowRunFilter

WorkflowRunFilter: object

The workflow run filter.

Optional status

The status of workflow run. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored'

serializedName

serializedName: string = "WorkflowRunFilter"

type

type: object

className

className: string = "WorkflowRunFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const WorkflowRunListResult

WorkflowRunListResult: object
interface

The list of workflow runs.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "WorkflowRunListResult"

__@iterator

  • Iterator

    Returns IterableIterator<WorkflowRun>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<WorkflowRun>[]

      Additional items to add to the end of array1.

    Returns WorkflowRun[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns WorkflowRun[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, WorkflowRun]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: WorkflowRun, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: WorkflowRun

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): WorkflowRun[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns WorkflowRun[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): WorkflowRun | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns WorkflowRun | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: WorkflowRun, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: WorkflowRun

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: WorkflowRun, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: WorkflowRun

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: WorkflowRun, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: WorkflowRun

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns WorkflowRun | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    • Rest ...items: WorkflowRun[]

      New elements of the Array.

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns WorkflowRun

  • Parameters

    Returns WorkflowRun

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • reduceRight(callbackfn: function): WorkflowRun
  • reduceRight(callbackfn: function, initialValue: WorkflowRun): WorkflowRun
  • reduceRight<U>(callbackfn: function, initialValue: U): U
  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns WorkflowRun

  • Parameters

    Returns WorkflowRun

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns WorkflowRun[]

shift

  • Removes the first element from an array and returns it.

    Returns WorkflowRun | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): WorkflowRun[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns WorkflowRun[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns WorkflowRun[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: WorkflowRun[]

      Elements to insert into the array in place of the deleted elements.

    Returns WorkflowRun[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: WorkflowRun[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<WorkflowRun>

type

type: object

className

className: string = "WorkflowRunListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WorkflowRun"

name

name: "Composite" = "Composite"

Const WorkflowRunTrigger

WorkflowRunTrigger: object

The workflow run trigger.

Optional code

code: undefined | string

Gets the code. NOTE: This property will not be serialized. It can only be populated by the server.

Optional correlation

correlation: Correlation

The run correlation.

Optional endTime

endTime: Date

Gets the end time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional error

error: any

Gets the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional inputs

inputs: any

Gets the inputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional inputsLink

inputsLink: ContentLink

Gets the link to inputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Gets the name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputs

outputs: any

Gets the outputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputsLink

outputsLink: ContentLink

Gets the link to outputs. NOTE: This property will not be serialized. It can only be populated by the server.

Optional scheduledTime

scheduledTime: Date

Gets the scheduled time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date

Gets the start time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

Gets the status. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored' NOTE: This property will not be serialized. It can only be populated by the server.

Optional trackedProperties

trackedProperties: any

Gets the tracked properties. NOTE: This property will not be serialized. It can only be populated by the server.

Optional trackingId

trackingId: undefined | string

Gets the tracking id. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkflowRunTrigger"

type

type: object

className

className: string = "WorkflowRunTrigger"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "code"

type

type: object

name

name: "String" = "String"

correlation

correlation: object

serializedName

serializedName: string = "correlation"

type

type: object

className

className: string = "Correlation"

name

name: "Composite" = "Composite"

endTime

endTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "DateTime" = "DateTime"

error

error: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "error"

type

type: object

name

name: "Object" = "Object"

inputs

inputs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "inputs"

type

type: object

name

name: "Object" = "Object"

inputsLink

inputsLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "inputsLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

outputs

outputs: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "outputs"

type

type: object

name

name: "Object" = "Object"

outputsLink

outputsLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "outputsLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

scheduledTime

scheduledTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "scheduledTime"

type

type: object

name

name: "DateTime" = "DateTime"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

trackedProperties

trackedProperties: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "trackedProperties"

type

type: object

name

name: "Object" = "Object"

trackingId

trackingId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "trackingId"

type

type: object

name

name: "String" = "String"

Const WorkflowTrigger

WorkflowTrigger: object

The workflow trigger.

Optional changedTime

changedTime: Date

Gets the changed time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdTime

createdTime: Date

Gets the created time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional lastExecutionTime

lastExecutionTime: Date

Gets the last execution time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Gets the workflow trigger name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional nextExecutionTime

nextExecutionTime: Date

Gets the next execution time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional provisioningState

Gets the provisioning state. Possible values include: 'NotSpecified', 'Accepted', 'Running', 'Ready', 'Creating', 'Created', 'Deleting', 'Deleted', 'Canceled', 'Failed', 'Succeeded', 'Moving', 'Updating', 'Registering', 'Registered', 'Unregistering', 'Unregistered', 'Completed' NOTE: This property will not be serialized. It can only be populated by the server.

Optional recurrence

Gets the workflow trigger recurrence. NOTE: This property will not be serialized. It can only be populated by the server.

Optional state

Gets the state. Possible values include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended' NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

Gets the status. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored' NOTE: This property will not be serialized. It can only be populated by the server.

Optional workflow

Gets the reference to workflow. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkflowTrigger"

Optional type

type: object

Gets the workflow trigger type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "WorkflowTrigger"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

changedTime

changedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.changedTime"

type

type: object

name

name: "DateTime" = "DateTime"

createdTime

createdTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

lastExecutionTime

lastExecutionTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.lastExecutionTime"

type

type: object

name

name: "DateTime" = "DateTime"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

nextExecutionTime

nextExecutionTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.nextExecutionTime"

type

type: object

name

name: "DateTime" = "DateTime"

provisioningState

provisioningState: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.provisioningState"

type

type: object

name

name: "String" = "String"

recurrence

recurrence: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.recurrence"

type

type: object

className

className: string = "WorkflowTriggerRecurrence"

name

name: "Composite" = "Composite"

state

state: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

workflow

workflow: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.workflow"

type

type: object

className

className: string = "ResourceReference"

name

name: "Composite" = "Composite"

Const WorkflowTriggerCallbackUrl

WorkflowTriggerCallbackUrl: object

The workflow trigger callback URL.

Optional basePath

basePath: undefined | string

Gets the workflow trigger callback URL base path. NOTE: This property will not be serialized. It can only be populated by the server.

Optional method

method: undefined | string

Gets the workflow trigger callback URL HTTP method. NOTE: This property will not be serialized. It can only be populated by the server.

Optional queries

Gets the workflow trigger callback URL query parameters.

Optional relativePath

relativePath: undefined | string

Gets the workflow trigger callback URL relative path. NOTE: This property will not be serialized. It can only be populated by the server.

Optional relativePathParameters

relativePathParameters: string[]

Gets the workflow trigger callback URL relative path parameters.

Optional value

value: undefined | string

Gets the workflow trigger callback URL. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkflowTriggerCallbackUrl"

type

type: object

className

className: string = "WorkflowTriggerCallbackUrl"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

basePath

basePath: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "basePath"

type

type: object

name

name: "String" = "String"

method

method: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "method"

type

type: object

name

name: "String" = "String"

queries

queries: object

serializedName

serializedName: string = "queries"

type

type: object

className

className: string = "WorkflowTriggerListCallbackUrlQueries"

name

name: "Composite" = "Composite"

relativePath

relativePath: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "relativePath"

type

type: object

name

name: "String" = "String"

relativePathParameters

relativePathParameters: object

serializedName

serializedName: string = "relativePathParameters"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

name

name: "String" = "String"

value

value: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "value"

type

type: object

name

name: "String" = "String"

Const WorkflowTriggerFilter

WorkflowTriggerFilter: object

The workflow trigger filter.

Optional state

The state of workflow trigger. Possible values include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended'

serializedName

serializedName: string = "WorkflowTriggerFilter"

type

type: object

className

className: string = "WorkflowTriggerFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

state

state: object

serializedName

serializedName: string = "state"

type

type: object

name

name: "String" = "String"

Const WorkflowTriggerHistory

WorkflowTriggerHistory: object

The workflow trigger history.

Optional code

code: undefined | string

Gets the code. NOTE: This property will not be serialized. It can only be populated by the server.

Optional correlation

correlation: Correlation

The run correlation.

Optional endTime

endTime: Date

Gets the end time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional error

error: any

Gets the error. NOTE: This property will not be serialized. It can only be populated by the server.

Optional fired

fired: undefined | false | true

Gets a value indicating whether trigger was fired. NOTE: This property will not be serialized. It can only be populated by the server.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional inputsLink

inputsLink: ContentLink

Gets the link to input parameters. NOTE: This property will not be serialized. It can only be populated by the server.

Optional name

name: undefined | string

Gets the workflow trigger history name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional outputsLink

outputsLink: ContentLink

Gets the link to output parameters. NOTE: This property will not be serialized. It can only be populated by the server.

Optional run

Gets the reference to workflow run. NOTE: This property will not be serialized. It can only be populated by the server.

Optional startTime

startTime: Date

Gets the start time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional status

Gets the status. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored' NOTE: This property will not be serialized. It can only be populated by the server.

Optional trackingId

trackingId: undefined | string

Gets the tracking id. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkflowTriggerHistory"

Optional type

type: object

Gets the workflow trigger history type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "WorkflowTriggerHistory"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

code

code: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.code"

type

type: object

name

name: "String" = "String"

correlation

correlation: object

serializedName

serializedName: string = "properties.correlation"

type

type: object

className

className: string = "Correlation"

name

name: "Composite" = "Composite"

endTime

endTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.endTime"

type

type: object

name

name: "DateTime" = "DateTime"

error

error: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.error"

type

type: object

name

name: "Object" = "Object"

fired

fired: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.fired"

type

type: object

name

name: "Boolean" = "Boolean"

inputsLink

inputsLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.inputsLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

name

name: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "name"

type

type: object

name

name: "String" = "String"

outputsLink

outputsLink: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.outputsLink"

type

type: object

className

className: string = "ContentLink"

name

name: "Composite" = "Composite"

run

run: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.run"

type

type: object

className

className: string = "ResourceReference"

name

name: "Composite" = "Composite"

startTime

startTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.startTime"

type

type: object

name

name: "DateTime" = "DateTime"

status

status: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.status"

type

type: object

name

name: "String" = "String"

trackingId

trackingId: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.trackingId"

type

type: object

name

name: "String" = "String"

type

type: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "type"

type

type: object

name

name: "String" = "String"

Const WorkflowTriggerHistoryFilter

WorkflowTriggerHistoryFilter: object

The workflow trigger history filter.

Optional status

The status of workflow trigger history. Possible values include: 'NotSpecified', 'Paused', 'Running', 'Waiting', 'Succeeded', 'Skipped', 'Suspended', 'Cancelled', 'Failed', 'Faulted', 'TimedOut', 'Aborted', 'Ignored'

serializedName

serializedName: string = "WorkflowTriggerHistoryFilter"

type

type: object

className

className: string = "WorkflowTriggerHistoryFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

status

status: object

serializedName

serializedName: string = "status"

type

type: object

name

name: "String" = "String"

Const WorkflowTriggerHistoryListResult

WorkflowTriggerHistoryListResult: object
interface

The list of workflow trigger histories.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "WorkflowTriggerHistoryListResult"

__@iterator

  • Iterator

    Returns IterableIterator<WorkflowTriggerHistory>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    Returns WorkflowTriggerHistory[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns WorkflowTriggerHistory[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, WorkflowTriggerHistory]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: WorkflowTriggerHistory

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): WorkflowTriggerHistory[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns WorkflowTriggerHistory[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): WorkflowTriggerHistory | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns WorkflowTriggerHistory | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: WorkflowTriggerHistory

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: WorkflowTriggerHistory

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: WorkflowTriggerHistory

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns WorkflowTriggerHistory | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

reduceRight

reverse

  • Reverses the elements in an Array.

    Returns WorkflowTriggerHistory[]

shift

  • Removes the first element from an array and returns it.

    Returns WorkflowTriggerHistory | undefined

slice

  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns WorkflowTriggerHistory[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns WorkflowTriggerHistory[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: WorkflowTriggerHistory[]

      Elements to insert into the array in place of the deleted elements.

    Returns WorkflowTriggerHistory[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<WorkflowTriggerHistory>

type

type: object

className

className: string = "WorkflowTriggerHistoryListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WorkflowTriggerHistory"

name

name: "Composite" = "Composite"

Const WorkflowTriggerListCallbackUrlQueries

WorkflowTriggerListCallbackUrlQueries: object

Gets the workflow trigger callback URL query parameters.

Optional apiVersion

apiVersion: undefined | string

The api version.

Optional se

se: undefined | string

The SAS timestamp.

Optional sig

sig: undefined | string

The SAS signature.

Optional sp

sp: undefined | string

The SAS permissions.

Optional sv

sv: undefined | string

The SAS version.

serializedName

serializedName: string = "WorkflowTriggerListCallbackUrlQueries"

type

type: object

className

className: string = "WorkflowTriggerListCallbackUrlQueries"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

apiVersion

apiVersion: object

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

se

se: object

serializedName

serializedName: string = "se"

type

type: object

name

name: "String" = "String"

sig

sig: object

serializedName

serializedName: string = "sig"

type

type: object

name

name: "String" = "String"

sp

sp: object

serializedName

serializedName: string = "sp"

type

type: object

name

name: "String" = "String"

sv

sv: object

serializedName

serializedName: string = "sv"

type

type: object

name

name: "String" = "String"

Const WorkflowTriggerListResult

WorkflowTriggerListResult: object
interface

The list of workflow triggers.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "WorkflowTriggerListResult"

__@iterator

  • Iterator

    Returns IterableIterator<WorkflowTrigger>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<WorkflowTrigger>[]

      Additional items to add to the end of array1.

    Returns WorkflowTrigger[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns WorkflowTrigger[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, WorkflowTrigger]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: WorkflowTrigger, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: WorkflowTrigger

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): WorkflowTrigger[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns WorkflowTrigger[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): WorkflowTrigger | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns WorkflowTrigger | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: WorkflowTrigger, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: WorkflowTrigger

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: WorkflowTrigger, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: WorkflowTrigger

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: WorkflowTrigger, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: WorkflowTrigger

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns WorkflowTrigger | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns WorkflowTrigger

  • Parameters

    Returns WorkflowTrigger

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns WorkflowTrigger

  • Parameters

    Returns WorkflowTrigger

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns WorkflowTrigger[]

shift

  • Removes the first element from an array and returns it.

    Returns WorkflowTrigger | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): WorkflowTrigger[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns WorkflowTrigger[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns WorkflowTrigger[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: WorkflowTrigger[]

      Elements to insert into the array in place of the deleted elements.

    Returns WorkflowTrigger[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: WorkflowTrigger[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<WorkflowTrigger>

type

type: object

className

className: string = "WorkflowTriggerListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WorkflowTrigger"

name

name: "Composite" = "Composite"

Const WorkflowTriggerRecurrence

WorkflowTriggerRecurrence: object

The workflow trigger recurrence.

Optional endTime

endTime: undefined | string

The end time.

Optional frequency

The frequency. Possible values include: 'NotSpecified', 'Second', 'Minute', 'Hour', 'Day', 'Week', 'Month', 'Year'

Optional interval

interval: undefined | number

The interval.

Optional schedule

The recurrence schedule.

Optional startTime

startTime: undefined | string

The start time.

Optional timeZone

timeZone: undefined | string

The time zone.

serializedName

serializedName: string = "WorkflowTriggerRecurrence"

type

type: object

className

className: string = "WorkflowTriggerRecurrence"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

endTime

endTime: object

serializedName

serializedName: string = "endTime"

type

type: object

name

name: "String" = "String"

frequency

frequency: object

serializedName

serializedName: string = "frequency"

type

type: object

name

name: "String" = "String"

interval

interval: object

serializedName

serializedName: string = "interval"

type

type: object

name

name: "Number" = "Number"

schedule

schedule: object

serializedName

serializedName: string = "schedule"

type

type: object

className

className: string = "RecurrenceSchedule"

name

name: "Composite" = "Composite"

startTime

startTime: object

serializedName

serializedName: string = "startTime"

type

type: object

name

name: "String" = "String"

timeZone

timeZone: object

serializedName

serializedName: string = "timeZone"

type

type: object

name

name: "String" = "String"

Const WorkflowVersion

WorkflowVersion: object

The workflow version.

Optional accessEndpoint

accessEndpoint: undefined | string

Gets the access endpoint. NOTE: This property will not be serialized. It can only be populated by the server.

Optional changedTime

changedTime: Date

Gets the changed time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional createdTime

createdTime: Date

Gets the created time. NOTE: This property will not be serialized. It can only be populated by the server.

Optional definition

definition: any

The definition.

Optional id

id: undefined | string

The resource id. NOTE: This property will not be serialized. It can only be populated by the server.

Optional integrationAccount

integrationAccount: ResourceReference

The integration account.

Optional location

location: undefined | string

The resource location.

Optional name

name: undefined | string

Gets the resource name. NOTE: This property will not be serialized. It can only be populated by the server.

Optional parameters

parameters: undefined | object

The parameters.

Optional sku

sku: Sku

The sku.

Optional state

The state. Possible values include: 'NotSpecified', 'Completed', 'Enabled', 'Disabled', 'Deleted', 'Suspended'

Optional tags

tags: undefined | object

The resource tags.

Optional version

version: undefined | string

Gets the version. NOTE: This property will not be serialized. It can only be populated by the server.

serializedName

serializedName: string = "WorkflowVersion"

Optional type

type: object

Gets the resource type. NOTE: This property will not be serialized. It can only be populated by the server.

className

className: string = "WorkflowVersion"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

accessEndpoint

accessEndpoint: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.accessEndpoint"

type

type: object

name

name: "String" = "String"

changedTime

changedTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.changedTime"

type

type: object

name

name: "DateTime" = "DateTime"

createdTime

createdTime: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.createdTime"

type

type: object

name

name: "DateTime" = "DateTime"

definition

definition: object

serializedName

serializedName: string = "properties.definition"

type

type: object

name

name: "Object" = "Object"

integrationAccount

integrationAccount: object

serializedName

serializedName: string = "properties.integrationAccount"

type

type: object

className

className: string = "ResourceReference"

name

name: "Composite" = "Composite"

parameters

parameters: object

serializedName

serializedName: string = "properties.parameters"

type

type: object

name

name: "Dictionary" = "Dictionary"

value

value: object

type

type: object

className

className: string = "WorkflowParameter"

name

name: "Composite" = "Composite"

sku

sku: object

serializedName

serializedName: string = "properties.sku"

type

type: object

className

className: string = "Sku"

name

name: "Composite" = "Composite"

state

state: object

serializedName

serializedName: string = "properties.state"

type

type: object

name

name: "String" = "String"

version

version: object

readOnly

readOnly: true = true

serializedName

serializedName: string = "properties.version"

type

type: object

name

name: "String" = "String"

Const WorkflowVersionListResult

WorkflowVersionListResult: object
interface

The list of workflow versions.

extends

Array

Array

Array: ArrayConstructor

length

length: number

Gets or sets the length of the array. This is a number one higher than the highest element defined in an array.

Optional nextLink

nextLink: undefined | string

The URL to get the next set of results.

serializedName

serializedName: string = "WorkflowVersionListResult"

__@iterator

  • Iterator

    Returns IterableIterator<WorkflowVersion>

__@unscopables

  • __@unscopables(): object
  • Returns an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Returns object

concat

  • Combines two or more arrays.

    Parameters

    • Rest ...items: ConcatArray<WorkflowVersion>[]

      Additional items to add to the end of array1.

    Returns WorkflowVersion[]

  • Combines two or more arrays.

    Parameters

    • Rest ...items: (T | ConcatArray<T>)[]

      Additional items to add to the end of array1.

    Returns WorkflowVersion[]

copyWithin

  • copyWithin(target: number, start: number, end?: undefined | number): this
  • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

    Parameters

    • target: number

      If target is negative, it is treated as length+target where length is the length of the array.

    • start: number

      If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    • Optional end: undefined | number

      If not specified, length of the this object is used as its default value.

    Returns this

entries

  • Returns an iterable of key, value pairs for every entry in the array

    Returns IterableIterator<[number, WorkflowVersion]>

every

  • every(callbackfn: function, thisArg?: any): boolean
  • Determines whether all the members of an array satisfy the specified test.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The every method calls the callbackfn function for each element in array1 until the callbackfn returns false, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

fill

  • fill(value: WorkflowVersion, start?: undefined | number, end?: undefined | number): this
  • Returns the this object after filling the section identified by start and end with value

    Parameters

    • value: WorkflowVersion

      value to fill array section with

    • Optional start: undefined | number

      index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

    • Optional end: undefined | number

      index to stop filling the array at. If end is negative, it is treated as length+end.

    Returns this

filter

  • filter<S>(callbackfn: function, thisArg?: any): S[]
  • filter(callbackfn: function, thisArg?: any): WorkflowVersion[]
  • Returns the elements of an array that meet the condition specified in a callback function.

    Type parameters

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns S[]

  • Returns the elements of an array that meet the condition specified in a callback function.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The filter method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns WorkflowVersion[]

find

  • find<S>(predicate: function, thisArg?: any): S | undefined
  • find(predicate: function, thisArg?: any): WorkflowVersion | undefined
  • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

    Type parameters

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns S | undefined

  • Parameters

    Returns WorkflowVersion | undefined

findIndex

  • findIndex(predicate: function, thisArg?: any): number
  • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

    Parameters

    • predicate: function

      find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

    • Optional thisArg: any

      If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

    Returns number

forEach

  • forEach(callbackfn: function, thisArg?: any): void
  • Performs the specified action for each element in an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns void

includes

  • includes(searchElement: WorkflowVersion, fromIndex?: undefined | number): boolean
  • Determines whether an array includes a certain element, returning true or false as appropriate.

    Parameters

    • searchElement: WorkflowVersion

      The element to search for.

    • Optional fromIndex: undefined | number

      The position in this array at which to begin searching for searchElement.

    Returns boolean

indexOf

  • indexOf(searchElement: WorkflowVersion, fromIndex?: undefined | number): number
  • Returns the index of the first occurrence of a value in an array.

    Parameters

    • searchElement: WorkflowVersion

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

    Returns number

join

  • join(separator?: undefined | string): string
  • Adds all the elements of an array separated by the specified separator string.

    Parameters

    • Optional separator: undefined | string

      A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

    Returns string

keys

  • keys(): IterableIterator<number>
  • Returns an iterable of keys in the array

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: WorkflowVersion, fromIndex?: undefined | number): number
  • Returns the index of the last occurrence of a specified value in an array.

    Parameters

    • searchElement: WorkflowVersion

      The value to locate in the array.

    • Optional fromIndex: undefined | number

      The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array.

    Returns number

map

  • map<U>(callbackfn: function, thisArg?: any): U[]
  • Calls a defined callback function on each element of an array, and returns an array that contains the results.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

pop

  • Removes the last element from an array and returns it.

    Returns WorkflowVersion | undefined

push

  • Appends new elements to an array, and returns the new length of the array.

    Parameters

    Returns number

reduce

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns WorkflowVersion

  • Parameters

    Returns WorkflowVersion

  • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reduceRight

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Parameters

    Returns WorkflowVersion

  • Parameters

    Returns WorkflowVersion

  • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

    Type parameters

    • U

    Parameters

    • callbackfn: function

      A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

    • initialValue: U

      If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

    Returns U

reverse

  • Reverses the elements in an Array.

    Returns WorkflowVersion[]

shift

  • Removes the first element from an array and returns it.

    Returns WorkflowVersion | undefined

slice

  • slice(start?: undefined | number, end?: undefined | number): WorkflowVersion[]
  • Returns a section of an array.

    Parameters

    • Optional start: undefined | number

      The beginning of the specified portion of the array.

    • Optional end: undefined | number

      The end of the specified portion of the array.

    Returns WorkflowVersion[]

some

  • some(callbackfn: function, thisArg?: any): boolean
  • Determines whether the specified callback function returns true for any element of an array.

    Parameters

    • callbackfn: function

      A function that accepts up to three arguments. The some method calls the callbackfn function for each element in array1 until the callbackfn returns true, or until the end of the array.

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns boolean

sort

  • sort(compareFn?: undefined | function): this
  • Sorts an array.

    Parameters

    • Optional compareFn: undefined | function

      The name of the function used to determine the order of the elements. If omitted, the elements are sorted in ascending, ASCII character order.

    Returns this

splice

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • Optional deleteCount: undefined | number

      The number of elements to remove.

    Returns WorkflowVersion[]

  • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

    Parameters

    • start: number

      The zero-based location in the array from which to start removing elements.

    • deleteCount: number

      The number of elements to remove.

    • Rest ...items: WorkflowVersion[]

      Elements to insert into the array in place of the deleted elements.

    Returns WorkflowVersion[]

toLocaleString

  • toLocaleString(): string
  • Returns a string representation of an array. The elements are converted to string using their toLocalString methods.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an array.

    Returns string

unshift

  • Inserts new elements at the start of an array.

    Parameters

    • Rest ...items: WorkflowVersion[]

      Elements to insert at the start of the Array.

    Returns number

values

  • Returns an iterable of values in the array

    Returns IterableIterator<WorkflowVersion>

type

type: object

className

className: string = "WorkflowVersionListResult"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

nextLink

nextLink: object

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

value

value: object

serializedName

serializedName: string = ""

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "WorkflowVersion"

name

name: "Composite" = "Composite"

Const X12AcknowledgementSettings

X12AcknowledgementSettings: object

The X12 agreement acknowledgement settings.

acknowledgementControlNumberLowerBound

acknowledgementControlNumberLowerBound: number

The acknowledgement control number lower bound.

Optional acknowledgementControlNumberPrefix

acknowledgementControlNumberPrefix: undefined | string

The acknowledgement control number prefix.

Optional acknowledgementControlNumberSuffix

acknowledgementControlNumberSuffix: undefined | string

The acknowledgement control number suffix.

acknowledgementControlNumberUpperBound

acknowledgementControlNumberUpperBound: number

The acknowledgement control number upper bound.

batchFunctionalAcknowledgements

batchFunctionalAcknowledgements: boolean

The value indicating whether to batch functional acknowledgements.

batchImplementationAcknowledgements

batchImplementationAcknowledgements: boolean

The value indicating whether to batch implementation acknowledgements.

batchTechnicalAcknowledgements

batchTechnicalAcknowledgements: boolean

The value indicating whether to batch the technical acknowledgements.

Optional functionalAcknowledgementVersion

functionalAcknowledgementVersion: undefined | string

The functional acknowledgement version.

Optional implementationAcknowledgementVersion

implementationAcknowledgementVersion: undefined | string

The implementation acknowledgement version.

needFunctionalAcknowledgement

needFunctionalAcknowledgement: boolean

The value indicating whether functional acknowledgement is needed.

needImplementationAcknowledgement

needImplementationAcknowledgement: boolean

The value indicating whether implementation acknowledgement is needed.

needLoopForValidMessages

needLoopForValidMessages: boolean

The value indicating whether a loop is needed for valid messages.

needTechnicalAcknowledgement

needTechnicalAcknowledgement: boolean

The value indicating whether technical acknowledgement is needed.

rolloverAcknowledgementControlNumber

rolloverAcknowledgementControlNumber: boolean

The value indicating whether to rollover acknowledgement control number.

sendSynchronousAcknowledgement

sendSynchronousAcknowledgement: boolean

The value indicating whether to send synchronous acknowledgement.

serializedName

serializedName: string = "X12AcknowledgementSettings"

type

type: object

className

className: string = "X12AcknowledgementSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

acknowledgementControlNumberLowerBound

acknowledgementControlNumberLowerBound: object

required

required: true = true

serializedName

serializedName: string = "acknowledgementControlNumberLowerBound"

type

type: object

name

name: "Number" = "Number"

acknowledgementControlNumberPrefix

acknowledgementControlNumberPrefix: object

serializedName

serializedName: string = "acknowledgementControlNumberPrefix"

type

type: object

name

name: "String" = "String"

acknowledgementControlNumberSuffix

acknowledgementControlNumberSuffix: object

serializedName

serializedName: string = "acknowledgementControlNumberSuffix"

type

type: object

name

name: "String" = "String"

acknowledgementControlNumberUpperBound

acknowledgementControlNumberUpperBound: object

required

required: true = true

serializedName

serializedName: string = "acknowledgementControlNumberUpperBound"

type

type: object

name

name: "Number" = "Number"

batchFunctionalAcknowledgements

batchFunctionalAcknowledgements: object

required

required: true = true

serializedName

serializedName: string = "batchFunctionalAcknowledgements"

type

type: object

name

name: "Boolean" = "Boolean"

batchImplementationAcknowledgements

batchImplementationAcknowledgements: object

required

required: true = true

serializedName

serializedName: string = "batchImplementationAcknowledgements"

type

type: object

name

name: "Boolean" = "Boolean"

batchTechnicalAcknowledgements

batchTechnicalAcknowledgements: object

required

required: true = true

serializedName

serializedName: string = "batchTechnicalAcknowledgements"

type

type: object

name

name: "Boolean" = "Boolean"

functionalAcknowledgementVersion

functionalAcknowledgementVersion: object

serializedName

serializedName: string = "functionalAcknowledgementVersion"

type

type: object

name

name: "String" = "String"

implementationAcknowledgementVersion

implementationAcknowledgementVersion: object

serializedName

serializedName: string = "implementationAcknowledgementVersion"

type

type: object

name

name: "String" = "String"

needFunctionalAcknowledgement

needFunctionalAcknowledgement: object

required

required: true = true

serializedName

serializedName: string = "needFunctionalAcknowledgement"

type

type: object

name

name: "Boolean" = "Boolean"

needImplementationAcknowledgement

needImplementationAcknowledgement: object

required

required: true = true

serializedName

serializedName: string = "needImplementationAcknowledgement"

type

type: object

name

name: "Boolean" = "Boolean"

needLoopForValidMessages

needLoopForValidMessages: object

required

required: true = true

serializedName

serializedName: string = "needLoopForValidMessages"

type

type: object

name

name: "Boolean" = "Boolean"

needTechnicalAcknowledgement

needTechnicalAcknowledgement: object

required

required: true = true

serializedName

serializedName: string = "needTechnicalAcknowledgement"

type

type: object

name

name: "Boolean" = "Boolean"

rolloverAcknowledgementControlNumber

rolloverAcknowledgementControlNumber: object

required

required: true = true

serializedName

serializedName: string = "rolloverAcknowledgementControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

sendSynchronousAcknowledgement

sendSynchronousAcknowledgement: object

required

required: true = true

serializedName

serializedName: string = "sendSynchronousAcknowledgement"

type

type: object

name

name: "Boolean" = "Boolean"

Const X12AgreementContent

X12AgreementContent: object

The X12 agreement content.

receiveAgreement

receiveAgreement: X12OneWayAgreement

The X12 one-way receive agreement.

sendAgreement

sendAgreement: X12OneWayAgreement

The X12 one-way send agreement.

serializedName

serializedName: string = "X12AgreementContent"

type

type: object

className

className: string = "X12AgreementContent"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

receiveAgreement

receiveAgreement: object

required

required: true = true

serializedName

serializedName: string = "receiveAgreement"

type

type: object

className

className: string = "X12OneWayAgreement"

name

name: "Composite" = "Composite"

sendAgreement

sendAgreement: object

required

required: true = true

serializedName

serializedName: string = "sendAgreement"

type

type: object

className

className: string = "X12OneWayAgreement"

name

name: "Composite" = "Composite"

Const X12DelimiterOverrides

X12DelimiterOverrides: object

The X12 delimiter override settings.

componentSeparator

componentSeparator: number

The component separator.

dataElementSeparator

dataElementSeparator: number

The data element separator.

Optional messageId

messageId: undefined | string

The message id.

Optional protocolVersion

protocolVersion: undefined | string

The protocol version.

replaceCharacter

replaceCharacter: number

The replacement character.

replaceSeparatorsInPayload

replaceSeparatorsInPayload: boolean

The value indicating whether to replace separators in payload.

segmentTerminator

segmentTerminator: number

The segment terminator.

segmentTerminatorSuffix

segmentTerminatorSuffix: SegmentTerminatorSuffix

The segment terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF'

Optional targetNamespace

targetNamespace: undefined | string

The target namespace on which this delimiter settings has to be applied.

serializedName

serializedName: string = "X12DelimiterOverrides"

type

type: object

className

className: string = "X12DelimiterOverrides"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

componentSeparator

componentSeparator: object

required

required: true = true

serializedName

serializedName: string = "componentSeparator"

type

type: object

name

name: "Number" = "Number"

dataElementSeparator

dataElementSeparator: object

required

required: true = true

serializedName

serializedName: string = "dataElementSeparator"

type

type: object

name

name: "Number" = "Number"

messageId

messageId: object

serializedName

serializedName: string = "messageId"

type

type: object

name

name: "String" = "String"

protocolVersion

protocolVersion: object

serializedName

serializedName: string = "protocolVersion"

type

type: object

name

name: "String" = "String"

replaceCharacter

replaceCharacter: object

required

required: true = true

serializedName

serializedName: string = "replaceCharacter"

type

type: object

name

name: "Number" = "Number"

replaceSeparatorsInPayload

replaceSeparatorsInPayload: object

required

required: true = true

serializedName

serializedName: string = "replaceSeparatorsInPayload"

type

type: object

name

name: "Boolean" = "Boolean"

segmentTerminator

segmentTerminator: object

required

required: true = true

serializedName

serializedName: string = "segmentTerminator"

type

type: object

name

name: "Number" = "Number"

segmentTerminatorSuffix

segmentTerminatorSuffix: object

required

required: true = true

serializedName

serializedName: string = "segmentTerminatorSuffix"

type

type: object

allowedValues

allowedValues: string[] = ["NotSpecified","None","CR","LF","CRLF"]

name

name: "Enum" = "Enum"

targetNamespace

targetNamespace: object

serializedName

serializedName: string = "targetNamespace"

type

type: object

name

name: "String" = "String"

Const X12EnvelopeOverride

X12EnvelopeOverride: object

The X12 envelope override settings.

dateFormat

dateFormat: X12DateFormat

The date format. Possible values include: 'NotSpecified', 'CCYYMMDD', 'YYMMDD'

Optional functionalIdentifierCode

functionalIdentifierCode: undefined | string

The functional identifier code.

headerVersion

headerVersion: string

The header version.

messageId

messageId: string

The message id on which this envelope settings has to be applied.

protocolVersion

protocolVersion: string

The protocol version on which this envelope settings has to be applied.

receiverApplicationId

receiverApplicationId: string

The receiver application id.

responsibleAgencyCode

responsibleAgencyCode: string

The responsible agency code.

senderApplicationId

senderApplicationId: string

The sender application id.

targetNamespace

targetNamespace: string

The target namespace on which this envelope settings has to be applied.

timeFormat

timeFormat: X12TimeFormat

The time format. Possible values include: 'NotSpecified', 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd'

serializedName

serializedName: string = "X12EnvelopeOverride"

type

type: object

className

className: string = "X12EnvelopeOverride"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

dateFormat

dateFormat: object

required

required: true = true

serializedName

serializedName: string = "dateFormat"

type

type: object

name

name: "String" = "String"

functionalIdentifierCode

functionalIdentifierCode: object

serializedName

serializedName: string = "functionalIdentifierCode"

type

type: object

name

name: "String" = "String"

headerVersion

headerVersion: object

required

required: true = true

serializedName

serializedName: string = "headerVersion"

type

type: object

name

name: "String" = "String"

messageId

messageId: object

required

required: true = true

serializedName

serializedName: string = "messageId"

type

type: object

name

name: "String" = "String"

protocolVersion

protocolVersion: object

required

required: true = true

serializedName

serializedName: string = "protocolVersion"

type

type: object

name

name: "String" = "String"

receiverApplicationId

receiverApplicationId: object

required

required: true = true

serializedName

serializedName: string = "receiverApplicationId"

type

type: object

name

name: "String" = "String"

responsibleAgencyCode

responsibleAgencyCode: object

required

required: true = true

serializedName

serializedName: string = "responsibleAgencyCode"

type

type: object

name

name: "String" = "String"

senderApplicationId

senderApplicationId: object

required

required: true = true

serializedName

serializedName: string = "senderApplicationId"

type

type: object

name

name: "String" = "String"

targetNamespace

targetNamespace: object

required

required: true = true

serializedName

serializedName: string = "targetNamespace"

type

type: object

name

name: "String" = "String"

timeFormat

timeFormat: object

required

required: true = true

serializedName

serializedName: string = "timeFormat"

type

type: object

name

name: "String" = "String"

Const X12EnvelopeSettings

X12EnvelopeSettings: object

The X12 agreement envelope settings.

controlStandardsId

controlStandardsId: number

The controls standards id.

controlVersionNumber

controlVersionNumber: string

The control version number.

enableDefaultGroupHeaders

enableDefaultGroupHeaders: boolean

The value indicating whether to enable default group headers.

Optional functionalGroupId

functionalGroupId: undefined | string

The functional group id.

groupControlNumberLowerBound

groupControlNumberLowerBound: number

The group control number lower bound.

groupControlNumberUpperBound

groupControlNumberUpperBound: number

The group control number upper bound.

groupHeaderAgencyCode

groupHeaderAgencyCode: string

The group header agency code.

groupHeaderDateFormat

groupHeaderDateFormat: X12DateFormat

The group header date format. Possible values include: 'NotSpecified', 'CCYYMMDD', 'YYMMDD'

groupHeaderTimeFormat

groupHeaderTimeFormat: X12TimeFormat

The group header time format. Possible values include: 'NotSpecified', 'HHMM', 'HHMMSS', 'HHMMSSdd', 'HHMMSSd'

groupHeaderVersion

groupHeaderVersion: string

The group header version.

interchangeControlNumberLowerBound

interchangeControlNumberLowerBound: number

The interchange control number lower bound.

interchangeControlNumberUpperBound

interchangeControlNumberUpperBound: number

The interchange control number upper bound.

overwriteExistingTransactionSetControlNumber

overwriteExistingTransactionSetControlNumber: boolean

The value indicating whether to overwrite existing transaction set control number.

receiverApplicationId

receiverApplicationId: string

The receiver application id.

rolloverGroupControlNumber

rolloverGroupControlNumber: boolean

The value indicating whether to rollover group control number.

rolloverInterchangeControlNumber

rolloverInterchangeControlNumber: boolean

The value indicating whether to rollover interchange control number.

rolloverTransactionSetControlNumber

rolloverTransactionSetControlNumber: boolean

The value indicating whether to rollover transaction set control number.

senderApplicationId

senderApplicationId: string

The sender application id.

transactionSetControlNumberLowerBound

transactionSetControlNumberLowerBound: number

The transaction set control number lower bound.

Optional transactionSetControlNumberPrefix

transactionSetControlNumberPrefix: undefined | string

The transaction set control number prefix.

Optional transactionSetControlNumberSuffix

transactionSetControlNumberSuffix: undefined | string

The transaction set control number suffix.

transactionSetControlNumberUpperBound

transactionSetControlNumberUpperBound: number

The transaction set control number upper bound.

usageIndicator

usageIndicator: UsageIndicator

The usage indicator. Possible values include: 'NotSpecified', 'Test', 'Information', 'Production'

useControlStandardsIdAsRepetitionCharacter

useControlStandardsIdAsRepetitionCharacter: boolean

The value indicating whether to use control standards id as repetition character.

serializedName

serializedName: string = "X12EnvelopeSettings"

type

type: object

className

className: string = "X12EnvelopeSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

controlStandardsId

controlStandardsId: object

required

required: true = true

serializedName

serializedName: string = "controlStandardsId"

type

type: object

name

name: "Number" = "Number"

controlVersionNumber

controlVersionNumber: object

required

required: true = true

serializedName

serializedName: string = "controlVersionNumber"

type

type: object

name

name: "String" = "String"

enableDefaultGroupHeaders

enableDefaultGroupHeaders: object

required

required: true = true

serializedName

serializedName: string = "enableDefaultGroupHeaders"

type

type: object

name

name: "Boolean" = "Boolean"

functionalGroupId

functionalGroupId: object

serializedName

serializedName: string = "functionalGroupId"

type

type: object

name

name: "String" = "String"

groupControlNumberLowerBound

groupControlNumberLowerBound: object

required

required: true = true

serializedName

serializedName: string = "groupControlNumberLowerBound"

type

type: object

name

name: "Number" = "Number"

groupControlNumberUpperBound

groupControlNumberUpperBound: object

required

required: true = true

serializedName

serializedName: string = "groupControlNumberUpperBound"

type

type: object

name

name: "Number" = "Number"

groupHeaderAgencyCode

groupHeaderAgencyCode: object

required

required: true = true

serializedName

serializedName: string = "groupHeaderAgencyCode"

type

type: object

name

name: "String" = "String"

groupHeaderDateFormat

groupHeaderDateFormat: object

required

required: true = true

serializedName

serializedName: string = "groupHeaderDateFormat"

type

type: object

name

name: "String" = "String"

groupHeaderTimeFormat

groupHeaderTimeFormat: object

required

required: true = true

serializedName

serializedName: string = "groupHeaderTimeFormat"

type

type: object

name

name: "String" = "String"

groupHeaderVersion

groupHeaderVersion: object

required

required: true = true

serializedName

serializedName: string = "groupHeaderVersion"

type

type: object

name

name: "String" = "String"

interchangeControlNumberLowerBound

interchangeControlNumberLowerBound: object

required

required: true = true

serializedName

serializedName: string = "interchangeControlNumberLowerBound"

type

type: object

name

name: "Number" = "Number"

interchangeControlNumberUpperBound

interchangeControlNumberUpperBound: object

required

required: true = true

serializedName

serializedName: string = "interchangeControlNumberUpperBound"

type

type: object

name

name: "Number" = "Number"

overwriteExistingTransactionSetControlNumber

overwriteExistingTransactionSetControlNumber: object

required

required: true = true

serializedName

serializedName: string = "overwriteExistingTransactionSetControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

receiverApplicationId

receiverApplicationId: object

required

required: true = true

serializedName

serializedName: string = "receiverApplicationId"

type

type: object

name

name: "String" = "String"

rolloverGroupControlNumber

rolloverGroupControlNumber: object

required

required: true = true

serializedName

serializedName: string = "rolloverGroupControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

rolloverInterchangeControlNumber

rolloverInterchangeControlNumber: object

required

required: true = true

serializedName

serializedName: string = "rolloverInterchangeControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

rolloverTransactionSetControlNumber

rolloverTransactionSetControlNumber: object

required

required: true = true

serializedName

serializedName: string = "rolloverTransactionSetControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

senderApplicationId

senderApplicationId: object

required

required: true = true

serializedName

serializedName: string = "senderApplicationId"

type

type: object

name

name: "String" = "String"

transactionSetControlNumberLowerBound

transactionSetControlNumberLowerBound: object

required

required: true = true

serializedName

serializedName: string = "transactionSetControlNumberLowerBound"

type

type: object

name

name: "Number" = "Number"

transactionSetControlNumberPrefix

transactionSetControlNumberPrefix: object

serializedName

serializedName: string = "transactionSetControlNumberPrefix"

type

type: object

name

name: "String" = "String"

transactionSetControlNumberSuffix

transactionSetControlNumberSuffix: object

serializedName

serializedName: string = "transactionSetControlNumberSuffix"

type

type: object

name

name: "String" = "String"

transactionSetControlNumberUpperBound

transactionSetControlNumberUpperBound: object

required

required: true = true

serializedName

serializedName: string = "transactionSetControlNumberUpperBound"

type

type: object

name

name: "Number" = "Number"

usageIndicator

usageIndicator: object

required

required: true = true

serializedName

serializedName: string = "usageIndicator"

type

type: object

name

name: "String" = "String"

useControlStandardsIdAsRepetitionCharacter

useControlStandardsIdAsRepetitionCharacter: object

required

required: true = true

serializedName

serializedName: string = "useControlStandardsIdAsRepetitionCharacter"

type

type: object

name

name: "Boolean" = "Boolean"

Const X12FramingSettings

X12FramingSettings: object

The X12 agreement framing settings.

characterSet

characterSet: X12CharacterSet

The X12 character set. Possible values include: 'NotSpecified', 'Basic', 'Extended', 'UTF8'

componentSeparator

componentSeparator: number

The component separator.

dataElementSeparator

dataElementSeparator: number

The data element separator.

replaceCharacter

replaceCharacter: number

The replacement character.

replaceSeparatorsInPayload

replaceSeparatorsInPayload: boolean

The value indicating whether to replace separators in payload.

segmentTerminator

segmentTerminator: number

The segment terminator.

segmentTerminatorSuffix

segmentTerminatorSuffix: SegmentTerminatorSuffix

The segment terminator suffix. Possible values include: 'NotSpecified', 'None', 'CR', 'LF', 'CRLF'

serializedName

serializedName: string = "X12FramingSettings"

type

type: object

className

className: string = "X12FramingSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

characterSet

characterSet: object

required

required: true = true

serializedName

serializedName: string = "characterSet"

type

type: object

name

name: "String" = "String"

componentSeparator

componentSeparator: object

required

required: true = true

serializedName

serializedName: string = "componentSeparator"

type

type: object

name

name: "Number" = "Number"

dataElementSeparator

dataElementSeparator: object

required

required: true = true

serializedName

serializedName: string = "dataElementSeparator"

type

type: object

name

name: "Number" = "Number"

replaceCharacter

replaceCharacter: object

required

required: true = true

serializedName

serializedName: string = "replaceCharacter"

type

type: object

name

name: "Number" = "Number"

replaceSeparatorsInPayload

replaceSeparatorsInPayload: object

required

required: true = true

serializedName

serializedName: string = "replaceSeparatorsInPayload"

type

type: object

name

name: "Boolean" = "Boolean"

segmentTerminator

segmentTerminator: object

required

required: true = true

serializedName

serializedName: string = "segmentTerminator"

type

type: object

name

name: "Number" = "Number"

segmentTerminatorSuffix

segmentTerminatorSuffix: object

required

required: true = true

serializedName

serializedName: string = "segmentTerminatorSuffix"

type

type: object

allowedValues

allowedValues: string[] = ["NotSpecified","None","CR","LF","CRLF"]

name

name: "Enum" = "Enum"

Const X12MessageFilter

X12MessageFilter: object

The X12 message filter for odata query.

messageFilterType

messageFilterType: MessageFilterType

The message filter type. Possible values include: 'NotSpecified', 'Include', 'Exclude'

serializedName

serializedName: string = "X12MessageFilter"

type

type: object

className

className: string = "X12MessageFilter"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

messageFilterType

messageFilterType: object

required

required: true = true

serializedName

serializedName: string = "messageFilterType"

type

type: object

name

name: "String" = "String"

Const X12MessageIdentifier

X12MessageIdentifier: object

The X12 message identifier.

messageId

messageId: string

The message id.

serializedName

serializedName: string = "X12MessageIdentifier"

type

type: object

className

className: string = "X12MessageIdentifier"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

messageId

messageId: object

required

required: true = true

serializedName

serializedName: string = "messageId"

type

type: object

name

name: "String" = "String"

Const X12OneWayAgreement

X12OneWayAgreement: object

The X12 one-way agreement.

protocolSettings

protocolSettings: X12ProtocolSettings

The X12 protocol settings.

receiverBusinessIdentity

receiverBusinessIdentity: BusinessIdentity

The receiver business identity

senderBusinessIdentity

senderBusinessIdentity: BusinessIdentity

The sender business identity

serializedName

serializedName: string = "X12OneWayAgreement"

type

type: object

className

className: string = "X12OneWayAgreement"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

protocolSettings

protocolSettings: object

required

required: true = true

serializedName

serializedName: string = "protocolSettings"

type

type: object

className

className: string = "X12ProtocolSettings"

name

name: "Composite" = "Composite"

receiverBusinessIdentity

receiverBusinessIdentity: object

required

required: true = true

serializedName

serializedName: string = "receiverBusinessIdentity"

type

type: object

className

className: string = "BusinessIdentity"

name

name: "Composite" = "Composite"

senderBusinessIdentity

senderBusinessIdentity: object

required

required: true = true

serializedName

serializedName: string = "senderBusinessIdentity"

type

type: object

className

className: string = "BusinessIdentity"

name

name: "Composite" = "Composite"

Const X12ProcessingSettings

X12ProcessingSettings: object

The X12 processing settings.

convertImpliedDecimal

convertImpliedDecimal: boolean

The value indicating whether to convert numerical type to implied decimal.

createEmptyXmlTagsForTrailingSeparators

createEmptyXmlTagsForTrailingSeparators: boolean

The value indicating whether to create empty xml tags for trailing separators.

maskSecurityInfo

maskSecurityInfo: boolean

The value indicating whether to mask security information.

preserveInterchange

preserveInterchange: boolean

The value indicating whether to preserve interchange.

suspendInterchangeOnError

suspendInterchangeOnError: boolean

The value indicating whether to suspend interchange on error.

useDotAsDecimalSeparator

useDotAsDecimalSeparator: boolean

The value indicating whether to use dot as decimal separator.

serializedName

serializedName: string = "X12ProcessingSettings"

type

type: object

className

className: string = "X12ProcessingSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

convertImpliedDecimal

convertImpliedDecimal: object

required

required: true = true

serializedName

serializedName: string = "convertImpliedDecimal"

type

type: object

name

name: "Boolean" = "Boolean"

createEmptyXmlTagsForTrailingSeparators

createEmptyXmlTagsForTrailingSeparators: object

required

required: true = true

serializedName

serializedName: string = "createEmptyXmlTagsForTrailingSeparators"

type

type: object

name

name: "Boolean" = "Boolean"

maskSecurityInfo

maskSecurityInfo: object

required

required: true = true

serializedName

serializedName: string = "maskSecurityInfo"

type

type: object

name

name: "Boolean" = "Boolean"

preserveInterchange

preserveInterchange: object

required

required: true = true

serializedName

serializedName: string = "preserveInterchange"

type

type: object

name

name: "Boolean" = "Boolean"

suspendInterchangeOnError

suspendInterchangeOnError: object

required

required: true = true

serializedName

serializedName: string = "suspendInterchangeOnError"

type

type: object

name

name: "Boolean" = "Boolean"

useDotAsDecimalSeparator

useDotAsDecimalSeparator: object

required

required: true = true

serializedName

serializedName: string = "useDotAsDecimalSeparator"

type

type: object

name

name: "Boolean" = "Boolean"

Const X12ProtocolSettings

X12ProtocolSettings: object

The X12 agreement protocol settings.

acknowledgementSettings

acknowledgementSettings: X12AcknowledgementSettings

The X12 acknowledgment settings.

Optional envelopeOverrides

envelopeOverrides: X12EnvelopeOverride[]

The X12 envelope override settings.

envelopeSettings

envelopeSettings: X12EnvelopeSettings

The X12 envelope settings.

framingSettings

framingSettings: X12FramingSettings

The X12 framing settings.

messageFilter

messageFilter: X12MessageFilter

The X12 message filter.

Optional messageFilterList

messageFilterList: X12MessageIdentifier[]

The X12 message filter list.

processingSettings

processingSettings: X12ProcessingSettings

The X12 processing settings.

schemaReferences

schemaReferences: X12SchemaReference[]

The X12 schema references.

securitySettings

securitySettings: X12SecuritySettings

The X12 security settings.

Optional validationOverrides

validationOverrides: X12ValidationOverride[]

The X12 validation override settings.

validationSettings

validationSettings: X12ValidationSettings

The X12 validation settings.

Optional x12DelimiterOverrides

x12DelimiterOverrides: X12DelimiterOverrides[]

The X12 delimiter override settings.

serializedName

serializedName: string = "X12ProtocolSettings"

type

type: object

className

className: string = "X12ProtocolSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

acknowledgementSettings

acknowledgementSettings: object

required

required: true = true

serializedName

serializedName: string = "acknowledgementSettings"

type

type: object

className

className: string = "X12AcknowledgementSettings"

name

name: "Composite" = "Composite"

envelopeOverrides

envelopeOverrides: object

serializedName

serializedName: string = "envelopeOverrides"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "X12EnvelopeOverride"

name

name: "Composite" = "Composite"

envelopeSettings

envelopeSettings: object

required

required: true = true

serializedName

serializedName: string = "envelopeSettings"

type

type: object

className

className: string = "X12EnvelopeSettings"

name

name: "Composite" = "Composite"

framingSettings

framingSettings: object

required

required: true = true

serializedName

serializedName: string = "framingSettings"

type

type: object

className

className: string = "X12FramingSettings"

name

name: "Composite" = "Composite"

messageFilter

messageFilter: object

required

required: true = true

serializedName

serializedName: string = "messageFilter"

type

type: object

className

className: string = "X12MessageFilter"

name

name: "Composite" = "Composite"

messageFilterList

messageFilterList: object

serializedName

serializedName: string = "messageFilterList"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "X12MessageIdentifier"

name

name: "Composite" = "Composite"

processingSettings

processingSettings: object

required

required: true = true

serializedName

serializedName: string = "processingSettings"

type

type: object

className

className: string = "X12ProcessingSettings"

name

name: "Composite" = "Composite"

schemaReferences

schemaReferences: object

required

required: true = true

serializedName

serializedName: string = "schemaReferences"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "X12SchemaReference"

name

name: "Composite" = "Composite"

securitySettings

securitySettings: object

required

required: true = true

serializedName

serializedName: string = "securitySettings"

type

type: object

className

className: string = "X12SecuritySettings"

name

name: "Composite" = "Composite"

validationOverrides

validationOverrides: object

serializedName

serializedName: string = "validationOverrides"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "X12ValidationOverride"

name

name: "Composite" = "Composite"

validationSettings

validationSettings: object

required

required: true = true

serializedName

serializedName: string = "validationSettings"

type

type: object

className

className: string = "X12ValidationSettings"

name

name: "Composite" = "Composite"

x12DelimiterOverrides

x12DelimiterOverrides: object

serializedName

serializedName: string = "x12DelimiterOverrides"

type

type: object

name

name: "Sequence" = "Sequence"

element

element: object

type

type: object

className

className: string = "X12DelimiterOverrides"

name

name: "Composite" = "Composite"

Const X12SchemaReference

X12SchemaReference: object

The X12 schema reference.

messageId

messageId: string

The message id.

schemaName

schemaName: string

The schema name.

schemaVersion

schemaVersion: string

The schema version.

Optional senderApplicationId

senderApplicationId: undefined | string

The sender application id.

serializedName

serializedName: string = "X12SchemaReference"

type

type: object

className

className: string = "X12SchemaReference"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

messageId

messageId: object

required

required: true = true

serializedName

serializedName: string = "messageId"

type

type: object

name

name: "String" = "String"

schemaName

schemaName: object

required

required: true = true

serializedName

serializedName: string = "schemaName"

type

type: object

name

name: "String" = "String"

schemaVersion

schemaVersion: object

required

required: true = true

serializedName

serializedName: string = "schemaVersion"

type

type: object

name

name: "String" = "String"

senderApplicationId

senderApplicationId: object

serializedName

serializedName: string = "senderApplicationId"

type

type: object

name

name: "String" = "String"

Const X12SecuritySettings

X12SecuritySettings: object

The X12 agreement security settings.

authorizationQualifier

authorizationQualifier: string

The authorization qualifier.

Optional authorizationValue

authorizationValue: undefined | string

The authorization value.

Optional passwordValue

passwordValue: undefined | string

The password value.

securityQualifier

securityQualifier: string

The security qualifier.

serializedName

serializedName: string = "X12SecuritySettings"

type

type: object

className

className: string = "X12SecuritySettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

authorizationQualifier

authorizationQualifier: object

required

required: true = true

serializedName

serializedName: string = "authorizationQualifier"

type

type: object

name

name: "String" = "String"

authorizationValue

authorizationValue: object

serializedName

serializedName: string = "authorizationValue"

type

type: object

name

name: "String" = "String"

passwordValue

passwordValue: object

serializedName

serializedName: string = "passwordValue"

type

type: object

name

name: "String" = "String"

securityQualifier

securityQualifier: object

required

required: true = true

serializedName

serializedName: string = "securityQualifier"

type

type: object

name

name: "String" = "String"

Const X12ValidationOverride

X12ValidationOverride: object

The X12 validation override settings.

allowLeadingAndTrailingSpacesAndZeroes

allowLeadingAndTrailingSpacesAndZeroes: boolean

The value indicating whether to allow leading and trailing spaces and zeroes.

messageId

messageId: string

The message id on which the validation settings has to be applied.

trailingSeparatorPolicy

trailingSeparatorPolicy: TrailingSeparatorPolicy

The trailing separator policy. Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', 'Mandatory'

trimLeadingAndTrailingSpacesAndZeroes

trimLeadingAndTrailingSpacesAndZeroes: boolean

The value indicating whether to trim leading and trailing spaces and zeroes.

validateCharacterSet

validateCharacterSet: boolean

The value indicating whether to validate character Set.

validateEDITypes

validateEDITypes: boolean

The value indicating whether to validate EDI types.

validateXSDTypes

validateXSDTypes: boolean

The value indicating whether to validate XSD types.

serializedName

serializedName: string = "X12ValidationOverride"

type

type: object

className

className: string = "X12ValidationOverride"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowLeadingAndTrailingSpacesAndZeroes

allowLeadingAndTrailingSpacesAndZeroes: object

required

required: true = true

serializedName

serializedName: string = "allowLeadingAndTrailingSpacesAndZeroes"

type

type: object

name

name: "Boolean" = "Boolean"

messageId

messageId: object

required

required: true = true

serializedName

serializedName: string = "messageId"

type

type: object

name

name: "String" = "String"

trailingSeparatorPolicy

trailingSeparatorPolicy: object

required

required: true = true

serializedName

serializedName: string = "trailingSeparatorPolicy"

type

type: object

name

name: "String" = "String"

trimLeadingAndTrailingSpacesAndZeroes

trimLeadingAndTrailingSpacesAndZeroes: object

required

required: true = true

serializedName

serializedName: string = "trimLeadingAndTrailingSpacesAndZeroes"

type

type: object

name

name: "Boolean" = "Boolean"

validateCharacterSet

validateCharacterSet: object

required

required: true = true

serializedName

serializedName: string = "validateCharacterSet"

type

type: object

name

name: "Boolean" = "Boolean"

validateEDITypes

validateEDITypes: object

required

required: true = true

serializedName

serializedName: string = "validateEDITypes"

type

type: object

name

name: "Boolean" = "Boolean"

validateXSDTypes

validateXSDTypes: object

required

required: true = true

serializedName

serializedName: string = "validateXSDTypes"

type

type: object

name

name: "Boolean" = "Boolean"

Const X12ValidationSettings

X12ValidationSettings: object

The X12 agreement validation settings.

allowLeadingAndTrailingSpacesAndZeroes

allowLeadingAndTrailingSpacesAndZeroes: boolean

The value indicating whether to allow leading and trailing spaces and zeroes.

checkDuplicateGroupControlNumber

checkDuplicateGroupControlNumber: boolean

The value indicating whether to check for duplicate group control number.

checkDuplicateInterchangeControlNumber

checkDuplicateInterchangeControlNumber: boolean

The value indicating whether to check for duplicate interchange control number.

checkDuplicateTransactionSetControlNumber

checkDuplicateTransactionSetControlNumber: boolean

The value indicating whether to check for duplicate transaction set control number.

interchangeControlNumberValidityDays

interchangeControlNumberValidityDays: number

The validity period of interchange control number.

trailingSeparatorPolicy

trailingSeparatorPolicy: TrailingSeparatorPolicy

The trailing separator policy. Possible values include: 'NotSpecified', 'NotAllowed', 'Optional', 'Mandatory'

trimLeadingAndTrailingSpacesAndZeroes

trimLeadingAndTrailingSpacesAndZeroes: boolean

The value indicating whether to trim leading and trailing spaces and zeroes.

validateCharacterSet

validateCharacterSet: boolean

The value indicating whether to validate character set in the message.

validateEDITypes

validateEDITypes: boolean

The value indicating whether to Whether to validate EDI types.

validateXSDTypes

validateXSDTypes: boolean

The value indicating whether to Whether to validate XSD types.

serializedName

serializedName: string = "X12ValidationSettings"

type

type: object

className

className: string = "X12ValidationSettings"

name

name: "Composite" = "Composite"

modelProperties

modelProperties: object

allowLeadingAndTrailingSpacesAndZeroes

allowLeadingAndTrailingSpacesAndZeroes: object

required

required: true = true

serializedName

serializedName: string = "allowLeadingAndTrailingSpacesAndZeroes"

type

type: object

name

name: "Boolean" = "Boolean"

checkDuplicateGroupControlNumber

checkDuplicateGroupControlNumber: object

required

required: true = true

serializedName

serializedName: string = "checkDuplicateGroupControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

checkDuplicateInterchangeControlNumber

checkDuplicateInterchangeControlNumber: object

required

required: true = true

serializedName

serializedName: string = "checkDuplicateInterchangeControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

checkDuplicateTransactionSetControlNumber

checkDuplicateTransactionSetControlNumber: object

required

required: true = true

serializedName

serializedName: string = "checkDuplicateTransactionSetControlNumber"

type

type: object

name

name: "Boolean" = "Boolean"

interchangeControlNumberValidityDays

interchangeControlNumberValidityDays: object

required

required: true = true

serializedName

serializedName: string = "interchangeControlNumberValidityDays"

type

type: object

name

name: "Number" = "Number"

trailingSeparatorPolicy

trailingSeparatorPolicy: object

required

required: true = true

serializedName

serializedName: string = "trailingSeparatorPolicy"

type

type: object

name

name: "String" = "String"

trimLeadingAndTrailingSpacesAndZeroes

trimLeadingAndTrailingSpacesAndZeroes: object

required

required: true = true

serializedName

serializedName: string = "trimLeadingAndTrailingSpacesAndZeroes"

type

type: object

name

name: "Boolean" = "Boolean"

validateCharacterSet

validateCharacterSet: object

required

required: true = true

serializedName

serializedName: string = "validateCharacterSet"

type

type: object

name

name: "Boolean" = "Boolean"

validateEDITypes

validateEDITypes: object

required

required: true = true

serializedName

serializedName: string = "validateEDITypes"

type

type: object

name

name: "Boolean" = "Boolean"

validateXSDTypes

validateXSDTypes: object

required

required: true = true

serializedName

serializedName: string = "validateXSDTypes"

type

type: object

name

name: "Boolean" = "Boolean"

Const acceptLanguage

acceptLanguage: object

parameterPath

parameterPath: string = "acceptLanguage"

mapper

mapper: object

defaultValue

defaultValue: string = "en-US"

serializedName

serializedName: string = "accept-language"

type

type: object

name

name: "String" = "String"

Const actionName

actionName: object

parameterPath

parameterPath: string = "actionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "actionName"

type

type: object

name

name: "String" = "String"

Const agreementName

agreementName: object

parameterPath

parameterPath: string = "agreementName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "agreementName"

type

type: object

name

name: "String" = "String"

Const apiVersion

apiVersion: object

parameterPath

parameterPath: string = "apiVersion"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "api-version"

type

type: object

name

name: "String" = "String"

Const assemblyArtifactName

assemblyArtifactName: object

parameterPath

parameterPath: string = "assemblyArtifactName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "assemblyArtifactName"

type

type: object

name

name: "String" = "String"

Const batchConfigurationName

batchConfigurationName: object

parameterPath

parameterPath: string = "batchConfigurationName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "batchConfigurationName"

type

type: object

name

name: "String" = "String"

Const certificateName

certificateName: object

parameterPath

parameterPath: string = "certificateName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "certificateName"

type

type: object

name

name: "String" = "String"

Const filter

filter: object

parameterPath

parameterPath: string[] = ["options","filter"]

mapper

mapper: object

serializedName

serializedName: string = "$filter"

type

type: object

name

name: "String" = "String"

Const historyName

historyName: object

parameterPath

parameterPath: string = "historyName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "historyName"

type

type: object

name

name: "String" = "String"

Const integrationAccountName

integrationAccountName: object

parameterPath

parameterPath: string = "integrationAccountName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "integrationAccountName"

type

type: object

name

name: "String" = "String"

Const location

location: object

parameterPath

parameterPath: string = "location"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "location"

type

type: object

name

name: "String" = "String"

Const mapName

mapName: object

parameterPath

parameterPath: string = "mapName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "mapName"

type

type: object

name

name: "String" = "String"

Const nextPageLink

nextPageLink: object

parameterPath

parameterPath: string = "nextPageLink"

skipEncoding

skipEncoding: true = true

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "nextLink"

type

type: object

name

name: "String" = "String"

Const operationId

operationId: object

parameterPath

parameterPath: string = "operationId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "operationId"

type

type: object

name

name: "String" = "String"

Const partnerName

partnerName: object

parameterPath

parameterPath: string = "partnerName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "partnerName"

type

type: object

name

name: "String" = "String"

Const repetitionName

repetitionName: object

parameterPath

parameterPath: string = "repetitionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "repetitionName"

type

type: object

name

name: "String" = "String"

Const requestHistoryName

requestHistoryName: object

parameterPath

parameterPath: string = "requestHistoryName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "requestHistoryName"

type

type: object

name

name: "String" = "String"

Const resourceGroupName

resourceGroupName: object

parameterPath

parameterPath: string = "resourceGroupName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "resourceGroupName"

type

type: object

name

name: "String" = "String"

Const runName

runName: object

parameterPath

parameterPath: string = "runName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "runName"

type

type: object

name

name: "String" = "String"

Const schemaName

schemaName: object

parameterPath

parameterPath: string = "schemaName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "schemaName"

type

type: object

name

name: "String" = "String"

Const sessionName

sessionName: object

parameterPath

parameterPath: string = "sessionName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "sessionName"

type

type: object

name

name: "String" = "String"

Const subscriptionId

subscriptionId: object

parameterPath

parameterPath: string = "subscriptionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "subscriptionId"

type

type: object

name

name: "String" = "String"

Const top

top: object

parameterPath

parameterPath: string[] = ["options","top"]

mapper

mapper: object

serializedName

serializedName: string = "$top"

type

type: object

name

name: "Number" = "Number"

Const triggerName

triggerName: object

parameterPath

parameterPath: string = "triggerName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "triggerName"

type

type: object

name

name: "String" = "String"

Const versionId

versionId: object

parameterPath

parameterPath: string = "versionId"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "versionId"

type

type: object

name

name: "String" = "String"

Const workflowName

workflowName: object

parameterPath

parameterPath: string = "workflowName"

mapper

mapper: object

required

required: true = true

serializedName

serializedName: string = "workflowName"

type

type: object

name

name: "String" = "String"

Generated using TypeDoc